build

Ladder recenter no kb

CMakeLists.txt

@@ -58,7 +58,6 @@ else ()
     COMMAND ln ARGS -sf ${EXTERNALS_ROOT}/lib/Release/libOnixS.IceImpactMulticastPriceFeedHandlerCpp.so.3.13.0.0 ${CMAKE_BINARY_DIR}/server
     COMMAND ln ARGS -sf ${EXTERNALS_ROOT}/lib/Release/libACE-5.7.5.so ${CMAKE_BINARY_DIR}/server
     COMMAND mkdir ARGS -p ${CMAKE_BINARY_DIR}/server/plugins
-    COMMAND ln ARGS -sf ${CMAKE_BINARY_DIR}/sdk/examples/order_plugin_example.so ${CMAKE_BINARY_DIR}/server/plugins/
     COMMENT "Creating server runtime layout"
     DEPENDS sparkd data_files_dir)  
 

doc/api/.gitignore

@@ -0,0 +1 @@
+public 

doc/api/config.toml

@@ -0,0 +1,15 @@
+# The URL the site will be built for
+base_url = "https://api.bluetradesys.com"
+
+title = "BTS Spark API"
+description = "Documentation for the BTS Spark API"
+
+compile_sass = true
+
+highlight_code = true
+highlight_theme = "kronuz"
+insert_anchor_links = true
+build_search_index = true
+
+[extra]
+author = "Blue Trading Systems"

doc/api/content/_index.md

@@ -0,0 +1,5 @@
++++
+title = "BTS Spark API"
++++
+
+This is index

doc/api/content/client/_index.md

@@ -0,0 +1,7 @@
++++
+title="Client API"
+template="client.html"
+sort_by="weight"
++++
+
+

doc/api/content/client/getting-started/_index.md

@@ -0,0 +1,7 @@
++++
+title="Getting Started"
+template="client.html"
+sort_by="weight"
+weight = 1
++++ 
+

doc/api/content/client/getting-started/install.md

@@ -0,0 +1,9 @@
++++
+title = "Install Prerequisites"
+template="client.html"
+weight = 1
++++
+
+## Coming Soon
+
+* Install .net core

doc/api/content/server/_index.md

@@ -0,0 +1,25 @@
++++
+title="Algo API"
+template="documentation.html"
+redirect_to = "server/getting-started/overview/"
+sort_by="weight"
++++ 
+
+Getting Started
+- Install (docker, editor)
+- Downloading
+- Write your first algo
+- Testing
+
+Reference
+- Subscriptions
+- Child Orders
+- Detaching
+- Attaching
+- ...
+
+Samples
+- Iceberg
+- Pro-rata
+
+

doc/api/content/server/getting-started/_index.md

@@ -0,0 +1,7 @@
++++
+title="Getting Started"
+template="documentation.html"
+sort_by="weight"
+weight = 1
++++ 
+

doc/api/content/server/getting-started/development.md

@@ -0,0 +1,138 @@
++++
+title = "Development"
+weight = 3
++++
+
+# Visual Studio Code
+
+In this section we're going to use the Remote - Containers feature of <a href="https://code.visualstudio.com/" target="_blank">Visual Studio Code<i class="fa fa-fw fa-window-restore" aria-hidden="true"></i></a> to simplify the development experience. If you are using a different editor skip to the <a href="#other-editors">other editor</a> section below.
+
+## Remote - Containers
+
+The Visual Studio Code Remote containers extension allows it to run a complete development environment inside the Spark SDK Docker container.  The editor UI runs as a thin client on your desktop and connects to a headless instance running inside the Spark SDK Docker environment.  This configuration allows us to ship a pre-configured set of [Tasks](https://code.visualstudio.com/Docs/editor/tasks) for building and testing your code.
+
+Start Visual Studio Code and click on the puzzle piece icon on the left-hand side to open the extensions panel. Use the search box at the top to find the "Remote - Containers" extension and install it.
+
+<img src="../vscode_remote_containers.png" width="640" />
+
+## Into the Code
+
+Open the examples/algo_template directory using the File->Open Folder menu option. If you opted to add it to your path during install, you could run `code .` from your command prompt.
+
+When the workspace opens, you should see a notification offering to let you re-open the workspace inside the container.
+
+<img src="../vscode_notification.png" width="480" />
+
+The first time you open the workspace inside the container it will take a few seconds to configure the spark_sdk docker container.  While the workspace is open in Visual Studio Code the docker image will also be running in the background.  The container will stop automatically when you close the editor.
+
+Open algo_template.cpp from the file browser on the left or by pressing ctrl-p and typing the name.  Each Algo is a standard C++ class which implements **IAlgoOrder**.  Placing your cursor on IAlgoOrder and pressing F12 will take you to the IAlgoOrder.h header file where you can browse the API.  To learn more about how an Algo is instantiated see the [Algo Initialization](/server/ref/initialization).
+
+## Compiling
+
+To build press "Ctrl+Shift+B".  You should see the build output at the bottom of your screen.  If the build was successful the resulting algo_template.so will be automatically copied to the plugins directory where it will be loaded by the Spark server process on start.
+
+<img src="../compiled.png" width="640" />
+
+## Debugging
+
+To debug your Algo set a breakpoint (F9) and open the Debug panel (Ctrl+Shift+D) and choose "(gdb) Launch".  This will launch the Spark Server inside the container with the debugger attached.  
+
+<img src="../gdb_launch.png" width="380" />
+
+With sparkd running you can launch the Spark Client (spark_client.cmd) and it will connect to the running server.  Log in with the user "bts" and no password and open a ladder.  You can now select your Algo on the order type dropdown and activate it by clicking on a price on the ladder.
+
+<img src="../myalgo.png" width="150" />
+
+While sparkd is running you can also access the Spark Server Admin interface on [http://localhost:9000](http://localhost:9000).  Use the same "bts" login to access the admin interface. Here you can manage user and account permissions and risk limits.
+
+## Starting Spark Server
+
+To start the Spark Server without attaching a debugger press "Ctrl+Shift+P" and select "Tasks: Run Task" and then "Start Sparkd" and "Never scan task output"  This will open a new terminal where you can see any messages logged with the **Sdk** subsystem as well as any warnings or errors.  To stop the Spark server simply kill the terminal (trash can icon) or run the "Stop Sparkd" task.
+
+## Next Steps
+
+If you would like to understand more about how Docker is working behind the scenes continue to the [next section](#other-editors).  Otherwise, continue to [Algo Registration](/server/ref/registration) to learn how Algos are registered with the Spark.
+
+<hr>
+
+# Other Editors
+
+In this section you will be more exposed to the details of how Docker works and how to compile and test your Algo using the command line. 
+
+## Docker
+
+Spark Server is built and runs only on Linux so you need a Linux development environment to effectively develop plug-ins for it. Docker lets you take the spark_sdk.img disk image and run it inside a virtual Linux machine running on your Windows desktop. 
+
+First, some terminology.  A Docker "image" is a disk image containing a complete filesystem. The spark_sdk.img file you imported earlier is an image.  A Docker "container" is what you get when you get when you attach this image to a running Linux system.  You can connect to a running container and use it to run commands like the C++ compiler or the Spark server.  Directories from your local filesystem can be mapped into the Docker container when it starts so you can easily share files.
+
+### Start
+
+The first step is to start the spark_sdk Docker container with the examples directory mapped so we can compile the examples inside the container. In your command prompt cd to the *examples* directory that you unzipped from the spark_sdk.zip file.  Then run the following command to start the container.
+
+Windows Command Prompt:
+{% clipable() %}
+docker run --rm -it -v %CD%:/examples -u bts -w /examples --shm-size 1024m --name spark_sdk -h spark_sdk --cap-add=SYS_PTRACE --security-opt seccomp=unconfined -p 9000:9000 -p 9001:9001 spark_sdk bash
+{% end %}
+
+**Powershell** / Linux / Mac:
+{% clipable() %}
+docker run --rm -it -v ${PWD}:/examples -u bts -w /examples --shm-size 1024m --name spark_sdk -h spark_sdk --cap-add=SYS_PTRACE --security-opt seccomp=unconfined -p 9000:9000 -p 9001:9001 spark_sdk bash
+{% end %}
+
+### Attach
+
+The container will remain as long as this prompt is open.  You can attach an additional to the running container with the following command:
+{% clipable() %}
+docker exec -it spark_sdk bash
+{% end %}
+
+## Compiling
+
+Let's look at the algo_template sample first.  All of the samples are laid out similarly with a `build.sh` script for compiling.  As long as you are running build.sh inside the spark Docker container, it automatically copies the build output to /sparkbin/plugins/ where it needs to be to get loaded by the Spark server.
+
+```
+bts@spark_sdk:/examples$ cd algo_template/
+bts@spark_sdk:/examples/algo_template$ ./build.sh
+algo_template.so copied to /sparkbin/plugins/
+Restart sparkd to see changes.
+```
+
+## Starting Spark Server
+
+To start the Spark server `cd /sparkbin/` and run `./sparkd run`.  Press Ctrl+C to stop it.
+```
+bts@spark_sdk:/sparkbin$ ./sparkd run
+2019-10-25 16:21:09.383626|262552152803600|Gen|Warn |1  |main|132 |Run.cpp:53 |dev|
+------------------------------------ Sparkd launched --------------------------------
+```
+
+You will see any Sdk log messages as well as any log messages at or above Warning level from other parts of the system.  If you need additional diagnostic information more details logs are stored in /sparkdata/data/logging/log.  These logs will be automatically deleted when you stop the Docker container.
+
+With sparkd running you can launch the Spark Client (spark_client.cmd) and it will connect to the running server.  Log in with the user "bts" and no password and open a ladder.  You can now select your Algo on the order type dropdown and activate it by clicking on a price on the ladder.
+
+<img src="../myalgo.png" width="150" />
+
+While sparkd is running you can also access the Spark Server Admin interface on [http://localhost:9000](http://localhost:9000).  Use the same "bts" login to access the admin interface. Here you can manage user and account permissions and risk limits.
+
+## Debugging
+
+You can debug your algo using gdb from the bash command prompt.  
+
+```bts@spark_sdk:/sparkbin$ gdb --args ./sparkd run
+GNU gdb (Ubuntu 8.1-0ubuntu3) 8.1.0.20180409-git
+Copyright (C) 2018 Free Software Foundation, Inc.
+...
+Reading symbols from ./sparkd...done.
+(gdb) break algo_template.cpp:45
+No source file named algo_template.cpp.
+Make breakpoint pending on future shared library load? (y or [n]) y
+Breakpoint 1 (algo_template.cpp:45) pending.
+(gdb) run
+Starting program: /sparkbin/sparkd run
+```
+
+If your editor supports debugging over the ssh protocol you can start sshd from inside the container.
+
+## Next
+
+Continue to [Algo Registration](/server/ref/registration) to learn how Algos are registered with the Spark.

doc/api/content/server/getting-started/download.md

@@ -0,0 +1,79 @@
++++
+title = "Download SDK"
+weight = 2
++++
+
+## Request Access 🔑
+
+To start using the Server SDK you will need to request access though our sales department.  Please email <a href="mailto:info@bluetradesys.com">info@bluetradesys.com</a> or call <a href="tel:919-913-0850">(919) 913-0850</a> and we will provide download credentials.
+
+## Download
+
+Download the latest SDK image here: [spark_sdk.zip](https://api.bluetradesys.com/download/spark_sdk.zip)
+
+Unzip that folder into a working directory. Inside you should see something like this:
+
+```
+spark_sdk.img
+client/
+spark_client.cmd
+examples/
+```
+
+## Import 
+
+Import the spark_sdk image into docker using the `docker load` command.
+{% clipable() %}
+docker load < spark_sdk.img
+{% end %}
+
+<div class="info">
+<i class="fa fa-lightbulb-o fa-fw" aria-hidden="true"></i>
+<strong>If you see this error it means Docker Desktop is not running:</strong>
+
+
+error during connect: Get http://%2F%2F.%2Fpipe%2Fdocker_engine/v1.40/images/json: open //./pipe/docker_engine: The system cannot find the file specified. In the default daemon configuration on Windows, the docker client must be run elevated to connect. This error may also indicate that the docker daemon is not running.
+</div>
+
+Confirm that the import worked by running `docker images` which should list the new image.
+```
+c:\bts> docker images
+REPOSITORY                          TAG            IMAGE ID            CREATED             SIZE
+bluetradingsystems/spark_sdk        latest         e2be89436e73        4 hours ago         3.89GB
+```
+
+<!-- 
+## Run 
+
+Start the docker container by running
+```
+docker run -d -v %CD%:/work --name spark_sdk --cap-add=SYS_PTRACE --security-opt seccomp=unconfined -p 8000:8000 -p 8001:8001 -p 8008:8008 bluetradingsytems/spark_sdk
+```
+<div class="linux">
+<i class="fa fa-linux fa-fw" aria-hidden="true"></i>
+If you are using Linux or Mac replace <strong>%CD%</strong> with <strong>$PWD</strong>.
+</div>
+
+The first time you invoke `docker run` you may be prompted to "share" your filesystem with Docker.  This usually works fine but if you run into trouble, see <a href="">Docker Desktop for Windows tips</a> on avoiding common problems.
+
+## Success 🎉
+Docker is now running the spark SDK image.  If you are on Windows or Mac it is running inside a virtual Linux machine. You can see that is is running by typing `docker ps` to list running docker containers.  If you restart the Docker Desktop application you will need to start the spark_sdk image again using `docker start spark_sdk`.
+
+You should now be able to access an admin interface at http://localhost:8008/ which will let you stop and start the spark server process. 
+-->
+
+## Update
+
+To update your Spark SDK simply download an unzip a new [spark_sdk.zip](https://api.bluetradesys.com/download/spark_sdk.zip) and use `docker load < spark_sdk.img` to overwrite the old image with the new one.
+
+To preserve the old image so you can go back to it later run `docker tag spark_sdk spark_sdk:your_custom_tag` before loading the new SDK image.
+
+<!--
+Then stop, remove and restart spark_sdk.
+```
+c:\bts> docker stop spark_sdk
+c:\bts> docker rm spark_sdk
+c:\bts> docker run -d -v %cd%:/sdk --name spark_sdk bluetradingsytems/spark_sdk
+
+``` -->
+

doc/api/content/server/getting-started/install.md

@@ -0,0 +1,57 @@
++++
+title = "Install Prerequisites"
+weight = 1
++++
+
+These instructions assume you are using Microsoft Windows but you should be able to follow them on a Linux or Mac with minor modifications.  
+
+{% linux() %}
+When there is a significant difference on non-Windows platforms it will be called out in a box like this one.
+{% end %}
+{% info() %}
+Tips or solutions to common problems will be highlighted in a box like this.
+{% end %}
+
+The minimum hardware requirements for using the SDK are:
+- **12 GB** RAM (preferably 16 GB or more)
+- 4 CPU cores
+- 20 GB free hard disk space
+
+The Spark SDK uses a tool called Docker to distribute all of the tools you need to build and test your trading algorithm ("Algo").  Once you have Docker installed you can download and import the Spark SDK image and be ready to start developing your Algo in a few minutes. 
+
+## Docker
+
+Download and install <a href="https://www.docker.com/products/docker-desktop" target="_blank">Docker Desktop for Windows/Mac. <i class="fa fa-fw fa-window-restore" aria-hidden="true"></i></a>
+
+<div class="linux">
+<i class="fa fa-linux fa-fw" aria-hidden="true"></i>
+If you are using Linux follow the <a href="https://docs.docker.com/install/#supported-platforms">official install instructions for Docker for your distribution.</a>
+</div>
+
+During the install Docker may ask you to enable virtualization support and reboot.
+
+Once Docker Desktop is installed and running it will create an icon in your system tray area that looks like the Docker logo.  
+![](../docker_tray.png)
+
+Right click on the tray icon and choose 'Settings' and choose the 'Advanced' tab.
+
+Ensure that the docker image has 8192 MB of memory and at least 2 cores.  Memory that you assign to the docker image will not be available to Windows/Mac while Docker is running. CPU cores are shared with the host OS.  Since you are going to use this image to compile your Algo it makes sense to allow Docker to use all available cores.
+
+<img src="../docker_config.png" width="640" >
+
+## Sharing
+
+You need to give Docker access to the Windows drive where your source code is kept. 
+
+Open Settings -> Shared Drives and check the drive where you intend to keep your Algo source code.
+
+<div class="info">
+<i class="fa fa-lightbulb-o fa-fw" aria-hidden="true"></i>
+If you run into trouble with drive sharing, see <a href="https://code.visualstudio.com/docs/remote/troubleshooting#_docker-desktop-for-windows-tips">Docker Desktop for Windows tips</a> on avoiding common problems.
+</div>
+
+## Editor
+
+The Server SDK includes a complete configuration for C++ development with the <a href="https://code.visualstudio.com/" target="_blank">Visual Studio Code <i class="fa fa-fw fa-window-restore" aria-hidden="true"></i></a> editor.  If you are a new to C++ development on a Linux system we recommend you give this a try as it's the easiest way to get up and running quickly. Of course, If you have a different editor that you prefer we fully support that as well.
+
+

doc/api/content/server/getting-started/overview.md

@@ -0,0 +1,44 @@
++++
+title = "Overview"
+weight = 0
++++
+
+Using the **Spark Server SDK**, users can create new order types ("Algos"). In this case, users implement the new functionality in C++, producing a shared library that is loaded at run time by our Spark Server.
+
+If you are interested in accessing Spark server remotely, please see the [Spark Client SDK](/client/).
+
+## Speed
+
+The Spark platform offers a sub-10 microsecond socket to socket response times for algorithmic trading.  With the **Spark Server SDK**, you can create your order types in high-performance C++ and load them into the Spark server. 
+
+Since your order is running inside the Spark Server, there is virtually no overhead allowing your algorithm to take full advantage of the speed Spark offers. Hosting a high-performance language like C++ directly in the Spark server process allows it to respond to the market thousands of times faster than an Algo built using a proprietary drag and drop tool.
+
+
+## Easy to Get Started
+
+If you are not actively developing with C++, it can be time-consuming to set up a complete development environment from scratch.  That is why we provide a full development environment out of the box with [Docker](https://docker.io) so you can download and try the Server SDK quickly and easily. 
+
+Docker works across Windows, macOS, and Linux, so you don't need to change your development environment to try the Spark API. Docker also ensures that all of the dependencies you need are packaged together in one image, so you know it will work out of the box, no matter the platform.
+
+## Implementation
+
+Creating a new Algo begins with implementing a standard C++ class derived from IAlgoOrder. Start from the [algo_template](/server/samples/template) example to get going quickly.
+
+The first call your new Algo receives is [do_before_launch](/server/ref/initialization#before-launch), which is an opportunity to validate parameters and allocate any long-lived resources needed during execution.  Next, it receives either [do_launch](/server/ref/initialization#launch-launch-attached) in the case of a new order or [do_launch_attached](/server/ref/initialization#launch-launch-attached) if the order is attaching to an existing order.
+
+The Algo receives a reference to [IAlgoServices](/server/ref/subscriptions/), which is how it calls out to the Spark system.  It will use [IAlgoServices](/server/ref/subscriptions/) to subscribe to market events, launch and control child orders, and communicate its state to the larger Spark system.
+
+## Fully Integrated
+
+When a Spark Server plugin is loaded, it registers its exposed Algos with the Spark Server though the [init_spark_plugin](/server/ref/registration) callback.  This callback allows the Algo to describe the parameters it expects so they can be automatically entered in the [Spark Client](https://www.bluetradingsystems.com/bts-spark/).
+
+<img src="../myalgo.png" width="150" />
+<img src="../paramsui.png" width="460" />
+
+Compose your Algo with out of the box Algos in the [Spark Algo Studio](https://www.bluetradingsystems.com/news/155-bts-algo-studio-provides-algo-library-with-customization-functionality) to create new functionality on the fly.
+
+<img src="../algostudio.png" width="548" /><br />
+<img src="../iced_algo.png" width="460" />
+
+
+

doc/api/content/server/ref/_index.md

@@ -0,0 +1,7 @@
++++
+title="Reference"
+template="documentation.html"
+sort_by="weight"
+weight = 2
++++ 
+

doc/api/content/server/ref/faq.md

@@ -0,0 +1,8 @@
++++
+title = "Questions"
+weight = 40
++++
+
+## I need to make a call that might take a few seconds. What is the best way to do this?
+
+Create a background thread in [do_before_launch](/server/ref/initialization#before-launch) or [do_launch](/server/ref/initialization#launch-launch-attached) to do the work.  Use [on_timer](/server/ref/subscriptions#timer) to poll until the result is available.

doc/api/content/server/ref/initialization.md

@@ -0,0 +1,97 @@
++++
+title = "Initialization"
+weight = 10
++++
+
+Each Algo derives from IAlgoOrder and overrides virtual methods to receive callbacks from the Spark system.
+
+
+## Before Launch
+
+When an order is activated by a user or by another Algo, the first call it receives is do_before_launch.  This call happens outside of the latency-sensitive path, so it's the place to validate parameters and set up data structures that the Algo might need.
+
+This call returns an OrderOpResult, which allows it to fail and return an error message to its creator.  If a user created this order, this message is displayed in the [Activity Log](https://www.bluetradingsystems.com/docs/bts_spark/Help/#activity-log) and across the bottom of the ladder.
+
+Every SDK Algo is a "Dynamic" Algo since it's parameters are defined during [registration](/server/ref/registration/). Use the `get_if<T>` helper to retrieve a named parameter from the `order_params` collection as a `std::option<T>`.  If a parameter has a valid default value you can use `std::option::value_or(...)` to set default values for missing parameters.  If a parameter *must* exist or must be within a certain valid range, return an error to the caller.
+
+```cpp
+OrderOpResult MyAlgo::do_before_launch(IBeforeLaunchAlgoServices& serv) {
+   auto& def = serv.definition();
+   auto& params = def.custom_def().dynamic().order_params();
+   auto mqi = get_if<uint32_t>(params, "Min Quantity");
+   if (!mqi || mqi.value() == 0)
+      return OrderOpResult{
+          ORDER_ERROR_INVALID_ORDER_DEFINITON,
+          "Min Quantity parameter must be defined and non zero"};
+}
+```
+
+<div class="info">
+<i class="fa fa-lightbulb-o fa-fw" aria-hidden="true"></i>
+The parameters are defined during <a href="/server/ref/registration/">registration</a> by the <a href="/server/ref/registration/#dynamicorderdescriptor">DynamicOrderDescriptor</a>.
+</div>
+
+### IBeforeLaunchAlgoServices
+
+IBeforeLaunchAlgoServices is passed to `do_before_launch` and allows the Algo to query its environment.
+
+```cpp
+class IBeforeLaunchAlgoServices {
+ public:
+   // The OrderDefinition for this algo
+   virtual api::orderman::OrderDefinition const &definition() const = 0;
+
+   // The security this algo is paramterized with (also available from
+   // definition())
+   virtual api::Security const &security() const = 0;
+
+   // The unique order key for this algo
+   virtual OrderKey order_key() const = 0;
+
+   // The parent key for this algo's parent or null_order_key() if the
+   // algo does not have a parent
+   virtual OrderKey parent_order_key() const = 0;
+
+   // The security identified by k or nullptr if no such security exists
+   virtual api::Security const *lookup_security(SecurityKey k) const = 0;
+
+   // Wheter this algo is being attached to an existing order.
+   // If an algo does not support attaching it can return an error 
+   // if is_attaching() == true from do_before_launch.
+   virtual bool is_attaching() const = 0;
+
+   // Build a child template that can later can be used to quickly
+   // launch child orders. The reserve parameter indicates how many
+   // orders should be created ahead of time, before they are
+   // launched. This is usefull to remove the relatively expensive
+   // order creation operation to a background thread.
+   virtual ChildTemplate &
+   make_child_template(api::orderman::OrderDefinition const &child_def,
+                       size_t reserve = 1) = 0;
+
+   // Get the current time
+   virtual TimeStamp get_time() const;
+};
+```
+
+
+## Launch / Launch Attached
+
+Depending on the state of `is_attaching()` the next call will either be `do_launch` or `do_launch_attached`.  The only difference is that in `do_launch_attached` the existing OrderKey and ChildState are provided.
+
+`do_launch` and `do_launch_attached` are in the latency-sensitive path and should not do more work than needed.  These functions get a reference to `IAlgoServices`, which is a superset of the functionality available on `IBeforeLaunchAlgoServices`.  Most Algos should store a pointer or reference to this object for managing child orders (it has a stable address).
+
+Now is the time to use `IAlgoServices` to subscribe to market events that are relevant to your Algo and create any child orders that need to exist at the start of your Algo. You can safely call IAlgoServices from any `IAlgoOrder` callback.
+
+To learn more about subscribing to events see [subscriptions](/server/ref/subscriptions).
+
+### Things to do in the launch callback
+☑ Store a reference to IAlgoServices  
+☑ Subscribe to relevant market events  
+☑ Launch a child order?
+
+
+## Update
+
+If the user or parent Algo changes the order parameters (price, size, or the custom parameters defined during registration), Spark calls the `do_update` callback with the new parameters.  It is up to the Algo to decide how to apply the new parameters to update the running state.  It can do this by canceling, changing, or adding new child orders. 
+

doc/api/content/server/ref/orders.md

@@ -0,0 +1,88 @@
++++
+title = "Child Orders"
+weight = 30
++++
+
+Every Algo must, at some point, launch a child order to be useful. Each child order can be another Algo or regular exchange order.  When the child order is updated or filled, those changes are also sent to the parent.
+
+
+# Templates
+
+Since launching a child order is one of the most latency-sensitive things an Algo can do, the Server SDK enables you to create a child template.  An order template prepares an order based on a known OrderDefinition and gets it ready to send on a background thread.  When the Algo determines it is time to send the order, it only needs to provide the price and quantity to complete and send the order.  If an Algo expects to send multiple child orders, it can reserve more than one.  Preparing a child template is typically done in [do_before_launch](http://127.0.0.1:1111/server/ref/initialization/#before-launch) callback.
+
+```cpp
+virtual ChildTemplate& 
+    IBeforeLaunchAlgoServices::make_child_template(
+        api::orderman::OrderDefinition const &child_def,
+        size_t reserve = 1);
+```
+
+# Launch
+
+IAlgoServices provides two overloads for launching child orders.  By default, launching a child order automatically subscribes the Algo to its state changes.
+
+Launch a child order from a template if you have one prepared. This is the fastest option.
+```cpp
+OrderKey IAlgoServices::launch_child(ChildTemplate&, Price, Quantity, bool subscribe = true);
+```
+Launch a child order by constructing an OrderDefinition as needed.
+```cpp
+OrderKey launch_child(OrderDefinition const &, Price, Quantity, bool subscribe = true);
+```
+
+When a child is launched its `OrderKey` is returned to the caller.  This ID can be used to update, cancel, or detach the child order.
+
+## Update
+
+To update an existing child order, call update_child and pass an Update.  The Update type lets you change the price, size or the entire OrderDefinition. You only need to specify the fields that you intend to update so only set the price() field if that is what you are changing.
+
+```cpp
+void IAlgoServices::update_child(OrderKey child, api::orderman::Update const &);
+```
+
+## Cancel
+
+To cancel an existing child order call `cancel_child`.  When the order is canceled you will receive an update though the `on_child_change` callback.
+
+```cpp
+void IAlgoServices::cancel_child(OrderKey child);
+```
+
+## Detach
+
+The lifetime of a child order is tied to its parent.  If a parent is canceled or completed child orders are automatically stopped as well.  If the Algo needs to launch an order that will continue after the Algo ends use `detach_child` to sever the connection.  This order hierarchy can be viewed in the Spark [Order Book](https://www.bluetradingsystems.com/docs/bts_spark/Trading/#order-book).
+
+```cpp
+void IAlgoServices::detach_child(OrderKey child);
+```
+To detach all children at once use `detach_all_children`.
+
+```cpp
+void IAlgoServices::detach_all_children();
+```
+
+# Child Updated
+
+When a child order is updated the parent receives the `on_child_change` callback with an updated ChildState object.
+
+```cpp
+void on_child_change(OrderKey, ChildState const &) override;
+
+struct ChildState {
+   Price price;
+   Quantity quantity;
+   Quantity total_fills;
+   Price avg_price;
+   Quantity last_fills;
+   Price last_price;
+   ChildStatus status;
+   Quantity fills_at_attach_time;
+};
+```
+
+<!--
+To talk about:
+- updating fills (update_fill_state)
+- handling child finished (unexpected cancel)
+-->
+

doc/api/content/server/ref/registration.md

@@ -0,0 +1,92 @@
++++
+title = "Registration"
+weight = 1
++++
+
+When Spark Server starts, it loads all plugins listed in the /sparkbin/plugins directory and calls an exported function named `init_spark_plugin` which must have the following signature.
+
+```cpp
+extern "C" void init_spark_plugin(bts::SparkServices &serv) { }
+```
+
+The `init_spark_plugin` function registers the Algo with a DynamicOrderDescriptor. Once registered, the Algo appears in the [Spark ladder](https://www.bluetradingsystems.com/docs/bts_spark/Trading/#ladder) and the [Algo Studio](https://www.bluetradingsystems.com/docs/bts_spark/Trading/#algo-studio).
+
+To register an Algo call `register_dynamic_algo_order` on the provided bts::SparkServices instance. This function takes the DynamicOrderDescriptor and a function that is called to construct the IAlgoOrder. A single init_spark_plugin can call register_dynamic_algo_order multiple times to register multiple Algos.
+
+The DynamicOrderDescriptor must have a dynamic_order_type (name), or the registration will fail.
+
+```cpp
+   DynamicOrderDescriptor desc;
+   desc.set_dynamic_order_type("My Algo");
+   auto result = 
+      serv.register_dynamic_algo_order(
+       desc, []() { return std::make_unique<MyAlgo>(); });
+   if (result != bts::AlgoRegistrationResult::SUCCESS) {
+       // Algo failed to register
+   }
+```
+
+
+## DynamicOrderDescriptor
+
+The DynamicOrderDescriptor describes the type of parameters that the Algo accepts.  These inputs can come either from the user manually entering them or from a parent Algo.  Spark Algos are composable, so one Algo can activate another.  See [Child Orders](/server/ref/orders) for more on how to activate custom order types as child orders.
+
+Add parameters to the DynamicOrderDescriptor by calling `add_param_desc()` and setting the name and parameter type.
+
+```cpp
+   *desc.add_param_desc() = param_bool("Enable Feature");
+   *desc.add_param_desc() = param_uint32("Feature Quantity");
+```
+
+The above parameters look like this when rendered in the Spark ladder.
+
+<img src="../paramsui.png" width="460" />
+
+And like this when viewed in the Spark order book.
+
+<img src="../orderbook_truncated.png" width="988" />
+
+Each descriptor can be one of the following types:
+```
+// Primitive
+int32
+uint32
+double
+string
+bool
+// Complex
+Order
+Array
+Struct
+```
+
+**Currently the Spark UI only renders parameters with primitive types.**  The complex types can only be provided by a parent order.
+
+### Order
+
+This parameter type indicates that another order type parameterizes this Algo. When the Algo needs to create a child order, it can use this parameter type to create a custom order type instead of defaulting to a limit order.
+
+For example, an Algo might be designed to wait for a specific market condition before putting in an order.  Instead of placing a limit order when the condition is met, the user can specify that it should an IceBerg order.  The Algo doesn't need special logic to handle different child order types.
+
+### Array
+
+An array parameter is a collection of the same type of parameter.  If your Algo needed to behave differently depending on a table of prices, you could send that list in though an array parameter.
+```cpp
+    *desc.add_param_desc() = 
+        param_array("Price Points", 
+            param_double("unused").param_type());
+```
+
+### Struct
+
+A struct parameter is a set of named parameter types similar to the entire DynamicOrderDescriptor.  The struct parameter type can be combined with the array type to handle tabular data.
+
+```cpp
+    *desc.add_param_desc() = 
+        param_array("Step Table", 
+            param_struct("", {
+                param_uint32("Market Quantity"),
+                param_uint32("Order Quantity")
+            }).param_type());
+```
+

doc/api/content/server/ref/subscriptions.md

@@ -0,0 +1,69 @@
++++
+title = "Subscriptions"
+weight = 20
++++
+
+An Algo exists to observe changes in the market and respond to them. When the Algo is [launched](1/server/ref/initialization/#launch-launch-attached) it uses IAlgoServices to subscribe to the events it needs to operate.  Each subscribe call is paired with a matching unsubscribe call, which takes the same argument to unsubscribe.
+
+# Book
+
+Subscribe to book updates for the specified security call use subscribe_book and unsubscribe book.
+```cpp
+// Subscribe to book updates for the specified security
+void IAlgoServices::subscribe_book(SecurityKey);
+void IAlgoServices::unsubscribe_book(SecurityKey);
+
+// You implement
+virtual void on_book(SecurityKey, Book const &) override;
+```
+Get the `SecurityKey` of the current security using:
+```cpp
+services.subscribe_book(SecurityKey(algo_services().security().id()));
+```
+If your Algo needs to subscribe to other securities, their keys must be passed in as parameters.
+
+
+To get the details of a security use
+```cpp
+api::Security const* IBeforeLaunchAlgoServices::lookup_security(SecurityKey k) const = 0;
+```
+
+# Timer
+To handle time-based logic, an Algo can subscribe to a common timer event that is invoked once every 10 milliseconds.  Use the TimeStamp class from `bts_chrono.h` to efficiently handle time calculations.
+```cpp
+// Subscribe to a periodic 10ms timer
+void IAlgoServices::subscribe_timer();
+// You implement
+virtual void on_timer() override;
+```
+
+# Ticker
+The status callback is called when the market for this security opens, closes, or has some other state transition.
+```cpp
+// Subscribe to trade ticker
+void IAlgoServices::subscribe_ticker(SecurityKey);
+// You implement
+void on_ticker(SecurityKey, TradeVector const&) override;
+```
+
+# Trading Status
+
+The status callback is called when the market for this security opens, closes, or has some other state transition.
+```cpp
+// Subscribe to security trading status
+void IAlgoServices::subscribe_status(SecurityKey);
+// You implement
+virtual void on_status(SecurityKey, co2::TradingStatus) override;
+```
+
+# Child Orders
+
+When an Algo launches a child order, it is subscribed to the changes on that child automatically.  If the Algo unsubscribes from those changes, it can re-subscribe using this method.
+
+```cpp
+// Subscribe to child order updates for the specified child order.
+void IAlgoServices::subscribe_child_change(OrderKey);
+// You implement
+virtual void on_child_change(OrderKey, ChildState const &) override;
+```
+

doc/api/content/server/samples/_index.md

@@ -0,0 +1,7 @@
++++
+title="Samples"
+template="documentation.html"
+sort_by="weight"
+weight = 3
++++ 
+

doc/api/content/server/samples/join.md

@@ -0,0 +1,354 @@
++++
+title = "Join"
+weight = 10
++++
+
+
+Join starts working N ticks away from the market (usually) and then watches for the opposite inside to become same side inside market; if there is then enough size on that market, it will join.
+
+<div class="info">
+<i class="fa fa-lightbulb-o fa-fw" aria-hidden="true"></i>
+This sample is part of the Server SDK examples included in the <a href="/server/getting-started/download/">spark_sdk.zip download</a>. 
+</div>
+
+```cpp
+#include "spark/lib/config/config.h"
+#include "spark/lib/config/protos/system.pb.h"
+#include "spark/lib/domain_model/Security.h"
+#include "spark/lib/orderman/orders/server/IAlgoOrder.h"
+#include "spark/lib/orderman/orders/server/IAlgoServices.h"
+#include "spark/lib/plugin/SparkServices.h"
+
+#include "spark/lib/orderman/order_factory/IOrderFactory.h"
+#include "spark/lib/orderman/orderman_utils/Book.h"
+#include "spark/lib/orderman/orderman_utils/orderman_utils.h"
+#include "spark/lib/utils/PBUtils.h"
+
+using namespace bts::api::orderman;
+using namespace bts::orderman;
+
+namespace bts {
+namespace order_example {
+
+// Join starts working N ticks away from the market (usually) and then
+// watches for the opposite inside to become same side inside market;
+// if there is then enough size on that market, it will join.
+class DynamicJoin : public IAlgoOrder {
+ public:
+   DynamicJoin();
+   ~DynamicJoin();
+
+   OrderOpResult do_before_launch(IBeforeLaunchAlgoServices &) override;
+   void do_launch(IAlgoServices &) override;
+   void do_launch_attached(IAlgoServices &, OrderKey, ChildState) override;
+   void do_update(api::orderman::Update const &) override;
+   void on_book(SecurityKey, Book const &) override;
+   void on_child_change(OrderKey, ChildState const &) override;
+
+ private:
+   enum class Status;
+   struct PImpl;
+   std::unique_ptr<PImpl> me;
+
+   IAlgoServices &algo_services() const;
+   void try_to_join();
+};
+
+// The three stages our algo goes through. We start by waiting to
+// observe the book for our security (WAITING_FOR_MD). Once we have a
+// book we use it to derive our target price and we continue to
+// monitor the book to see if we should join the market
+// (WAITING_TO_JOIN). Once the size and price constraints are met we
+// jump to the target price (JOINED). We remain in the JOINED state
+// until our order is filled or canceled.
+enum class DynamicJoin::Status { WAITING_FOR_MD, WAITING_TO_JOIN, JOINED };
+
+// All state information needed for this algo
+struct DynamicJoin::PImpl {
+   IAlgoServices *algo_services;
+   Quantity min_quantity_to_join;
+   Status status = Status::WAITING_FOR_MD;
+   OrderKey child_key = null_order_key();
+   ChildTemplate *child_template = nullptr;
+   Book book_at_inception;
+   Book last_book;
+};
+
+DynamicJoin::DynamicJoin() : me(new PImpl()) {}
+DynamicJoin::~DynamicJoin() {}
+IAlgoServices &DynamicJoin::algo_services() const { return *me->algo_services; }
+
+// This is called outside of the latency sensitive path
+// once. Expensive initialization should be done here, rather than 
+// in do_launch()
+OrderOpResult DynamicJoin::do_before_launch(IBeforeLaunchAlgoServices &serv) {
+   auto &def = serv.definition();
+   bts_assert(def.has_custom_def());
+   bts_assert(def.custom_def().has_dynamic());
+
+   // Validate our parameters, returning an error if we find a
+   // problem.  If an error is returned here the order will be
+   // abandoned.
+   auto &params = def.custom_def().dynamic().order_params();
+   auto mqi = get_if<uint32_t>(params, "Min Quantity");
+   if (!mqi || mqi.value() == 0) {
+      return OrderOpResult{
+          ORDER_ERROR_INVALID_ORDER_DEFINITON,
+          "Min Quantity parameter must be defined and non zero"};
+   }
+
+   me->min_quantity_to_join = Quantity(mqi.value());
+
+   if (!serv.is_attaching()) {
+      // If we are not attaching, create a child template so we can
+      // quickly launch our child when the time comes.
+
+      // We will be sending a limit order with the same side,
+      // security, trader, account, etc, as this algo order, so just
+      // copy our definition to the child definition to start with.
+      auto child_def = def;
+      // Now add a limit order component to mark our child as a limit
+      // order. Limit orders do not require any extra parameters
+      // beyond those already inherited from this algo order
+      // (i.e. beyond what we obtained through serv.definition()) so
+      // we can just use a default constructed LimitOrderDefinition.
+      *child_def.mutable_custom_def()->mutable_limit() = LimitOrderDefinition{};
+      // Now just build the child template and cache it for future use
+      me->child_template = &(serv.make_child_template(child_def));
+   } else {
+      // If we are attaching to an existing order then we do not need
+      // to spawn a new child, so there is no need to setup a child
+      // template
+   }
+
+   // All is good, return a default constructed OrderOpResult which
+   // indicates success.
+   return {};
+}
+
+// Called in the latency sensitive path, once, when the algo is first
+// launched.
+void DynamicJoin::do_launch(IAlgoServices &services) {
+   // Cache our algo services
+   me->algo_services = &services;
+
+   LOG(OrderMan, Diag, "Lauching DynamicJoin k: {} ",
+       algo_services().order_key().value());
+
+   // Launch our child order
+   me->child_key =
+       services.launch_child(*me->child_template, algo_services().price(),
+                             algo_services().quantity());
+
+   // Subscribe to market data
+   services.subscribe_book(SecurityKey(algo_services().security().id()));
+}
+
+// Called in the latency sensitive path, once, when the algo is first
+// launched. In this case the algo is provided with an existing order
+// it is now responsible for managing.
+void DynamicJoin::do_launch_attached(IAlgoServices &services,
+                                     OrderKey attached_order, ChildState st) {
+   // The order was launched and attached to an existing order, with
+   // key 'attached_order' and current state 'st'
+
+   // Cache our algo services
+   me->algo_services = &services;
+
+   LOG(OrderMan, Diag,
+       "Lauching DynamicJoin k: {} Attached to existing order: {}",
+       algo_services().order_key().value(), attached_order.value());
+
+   // Cache the key of the attached order we will be managing
+   me->child_key = attached_order;
+
+   // Subscribe to market data
+   services.subscribe_book(SecurityKey(services.security().id()));
+
+   // Simulate a child change so we can update our own state to
+   // reflect that of the child order we attached to. From this point
+   // forward there is no distinction between an algo instance that
+   // spawned a new child order and one that attached to an existing
+   // order.
+   on_child_change(attached_order, st);
+}
+
+// Called when a human (or a supervising algo) updates a parameter for
+// this algo. The implementation validates the update and depending on
+// the validation outcome either applies the update or terminates the
+// algo.
+void DynamicJoin::do_update(api::orderman::Update const &update) {
+   LOG(OrderMan, Diag, "DynamicJoin k: {} receiving update: {}",
+       algo_services().order_key().value(), utils::pb::to_string(update));
+
+   // Validate update
+   if (update.quantity() == 0) {
+      // An invalid update has been detected so we terminate the
+      // algo, signaling an error. Any child orders launched by
+      // this algo will also be terminated.
+      algo_services().terminate_error("Invalid update");
+      return;
+   }
+
+   // Updates have two parts, a standard part consisting of price and
+   // size and present in all updates, and an optional part that is
+   // specific to the algo in question. Below we check for the
+   // existance of this optional part and validate if present.
+   bool has_new_min_qty = false;
+   if (update.has_custom()) {
+      auto &params = update.custom().dynamic().order_params();
+      auto mqi = params.find("Min Quantity");
+
+      if (mqi == params.end() || mqi->second.as_uint32() == 0) {
+         algo_services().terminate_error(
+             "Minimum quantity to join must be greater than 0");
+         return;
+      }
+      has_new_min_qty = true;
+      me->min_quantity_to_join = Quantity(mqi->second.as_uint32());
+   }
+
+   // Update is good, forward it to our child
+   Update child_update;
+   child_update.set_price(update.price());
+   child_update.set_quantity(update.quantity());
+   algo_services().update_child(me->child_key, child_update);
+
+   // Try to join again if conditions changed
+   if (me->status == Status::WAITING_TO_JOIN && has_new_min_qty)
+      try_to_join();
+}
+
+// Called when the book for the specified security has changed
+void DynamicJoin::on_book(SecurityKey, Book const &b) {
+
+   // Cache the book, so we can reffer to it in the event of a
+   // parameter change that might allow us to join
+   me->last_book = b;
+
+   LOG(OrderMan, Diag, "DynamicJoin order {} on book. BID: {}@{} ASK: {}@{}",
+       algo_services().order_key().value(), b.side(api::SIDE_BUY)[0].size(),
+       b.side(api::SIDE_BUY)[0].price(), b.side(api::SIDE_SELL)[0].size(),
+       b.side(api::SIDE_SELL)[0].price());
+
+   switch (me->status) {
+   case Status::WAITING_FOR_MD: {
+
+      auto other_side =
+          securities::other_side(algo_services().definition().side());
+      auto &other_side_top = me->last_book.side(other_side)[0];
+
+      if (other_side_top.size() > 0) {
+         // First time we get the opposite side market, we will use
+         // this price as the target price for the join
+         me->status = Status::WAITING_TO_JOIN;
+         me->book_at_inception = b;
+         LOG(OrderMan, Diag,
+             "JoinOrder order {} receiving first book: {} Target: {}",
+             algo_services().order_key().value(),
+             me->min_quantity_to_join.value(), other_side_top.price());
+         try_to_join();
+      }
+   } break;
+   case Status::JOINED:
+      // Nothing to do at this point
+      break;
+   case Status::WAITING_TO_JOIN:
+      // Check if we reached the target and join if so
+      try_to_join();
+      break;
+   }
+}
+
+// Given the current book, our target price and our min quantity
+// parameter, join if appropriate
+void DynamicJoin::try_to_join() {
+   bts_assert(me->status == Status::WAITING_TO_JOIN);
+
+   auto my_side = algo_services().definition().side();
+   auto other_side = securities::other_side(my_side);
+   auto &my_side_psz = me->last_book.side(my_side)[0];
+   auto &opposite_at_inception_psz = me->book_at_inception.side(other_side)[0];
+
+   if (my_side_psz.size() &&
+       my_side_psz.size() >= me->min_quantity_to_join.value() &&
+       securities::is_equal_or_better(
+           my_side, Price(my_side_psz.price()),
+           Price(opposite_at_inception_psz.price()))) {
+
+      // Time to update our child to join the market
+      Update child_update;
+      child_update.set_price(my_side_psz.price());
+      child_update.set_quantity(algo_services().quantity().value());
+      algo_services().update_child(me->child_key, child_update);
+      me->status = Status::JOINED;
+
+      LOG(OrderMan, Diag, "DynamicJoin order {} joined: {}@{}",
+          algo_services().order_key().value(),
+          algo_services().quantity().value(), my_side_psz.price());
+
+   } else {
+      LOG(OrderMan, Diag,
+          "JoinOrder order {} still waiting to join. Order: {}@{} Top of "
+          "the book: {}@{} Target: {}@{}",
+          algo_services().order_key().value(),
+          algo_services().quantity().value(), algo_services().price().value(),
+          my_side_psz.size(), my_side_psz.price(),
+          me->min_quantity_to_join.value(), opposite_at_inception_psz.price());
+   }
+}
+
+// Our child reported a change:
+void DynamicJoin::on_child_change(OrderKey, ChildState const &st) {
+   // Our fill quantity and price is always a reflection of our
+   // child's state
+   algo_services().update_fill_state(st.total_fills, st.last_price);
+
+   switch (st.status) {
+   case ChildStatus::WORKING:
+      // Child order is still working, nothing to do
+      return;
+   case ChildStatus::COMPLETED:
+      // Child order completed, we should also complete
+      algo_services().complete();
+      return;
+   case ChildStatus::CANCELED:
+      // Child order unexpectedly canceled, signal an error and
+      // terminate
+      algo_services().terminate_error("Unexpected child cancel");
+      return;
+   }
+}
+
+// This is called by the spark daemon at startup. In this call we
+// describe our algo's parameters and register a factory function to
+// create an instance of the algo.
+extern "C" void init_spark_plugin(bts::SparkServices &serv) {
+   using namespace bts;
+
+   DynamicOrderDescriptor join_desc;
+
+   // Start by naming our order type
+   join_desc.set_dynamic_order_type("dyn join");
+
+   // Now add a single unsigned int parameter, Min Quantity, that will
+   // determine the minimum quantity that must exist in the book in
+   // order for us to join the market.
+   *join_desc.add_param_desc() = param_uint32("Min Quantity");
+
+   // Associate the descriptor with a builder function and register
+   // that with the Spark server.
+   auto result = 
+      serv.register_dynamic_algo_order(
+       join_desc, []() { return std::make_unique<DynamicJoin>(); });
+
+   if (result != bts::AlgoRegistrationResult::SUCCESS) {
+      // The join_desc has errors
+      // Check the error log for more details
+   }
+}
+
+} // namespace order_example
+} // namespace bts
+
+```

doc/api/content/server/samples/template.md

@@ -0,0 +1,146 @@
++++
+title = "Template"
+weight = 5
++++
+
+A mostly blank Algo template that can be used as a jump-start for developing a new Algo.
+
+<div class="info">
+<i class="fa fa-lightbulb-o fa-fw" aria-hidden="true"></i>
+This sample is part of the Server SDK examples included in the <a href="/server/getting-started/download/">spark_sdk.zip download</a>. 
+</div>
+
+```cpp
+#include "spark/lib/config/config.h"
+#include "spark/lib/config/protos/system.pb.h"
+#include "spark/lib/domain_model/Security.h"
+#include "spark/lib/orderman/orders/algo/IAlgoOrder.h"
+#include "spark/lib/orderman/orders/algo/IAlgoServices.h"
+#include "spark/lib/plugin/SparkServices.h"
+
+#include "spark/lib/orderman/order_factory/IOrderFactory.h"
+#include "spark/lib/orderman/orderman_utils/Book.h"
+#include "spark/lib/orderman/orderman_utils/orderman_utils.h"
+#include "spark/lib/utils/PBUtils.h"
+
+using namespace bts::api::orderman;
+using namespace bts::orderman;
+
+namespace bts {
+namespace order_example {
+
+// MyAlgo is a blank IAlgoOrder which you can copy when starting a new Algo
+class MyAlgo : public IAlgoOrder {
+ public:
+   MyAlgo();
+   ~MyAlgo();
+
+   OrderOpResult do_before_launch(IBeforeLaunchAlgoServices &) override;
+   void do_launch(IAlgoServices &) override;
+   void do_launch_attached(IAlgoServices &, OrderKey, ChildState) override;
+   void do_update(api::orderman::Update const &) override;
+   void on_book(SecurityKey, Book const &) override;
+   void on_child_change(OrderKey, ChildState const &) override;
+
+ private:
+   IAlgoServices* algo_services;
+   ChildTemplate *child_template = nullptr;
+   OrderKey child_key = null_order_key();
+};
+
+
+MyAlgo::MyAlgo() : algo_services(nullptr) {}
+MyAlgo::~MyAlgo() {}
+
+// This is called outside of the latency sensitive path. 
+// Expensive initialization should be done here, rather than in do_launch()
+OrderOpResult MyAlgo::do_before_launch(IBeforeLaunchAlgoServices &serv) {
+   LOG(Sdk,Info, "MyAlgo: do_before_launch");
+   // If we are not attaching, create a child template so we can
+   // quickly launch our child when the time comes.
+   if (!serv.is_attaching()) {
+      // We will be sending a limit order with the same side,
+      // security, trader, account, etc, as this algo order, so just
+      // copy our definition to the child definition to start with.
+      auto child_def = serv.definition();
+      // Now add a limit order component to mark our child as a limit
+      // order. Limit orders do not require any extra parameters
+      // beyond those already inherited from this algo order
+      // (i.e. beyond what we obtained through serv.definition()) so
+      // we can just use a default constructed LimitOrderDefinition.
+      *child_def.mutable_custom_def()->mutable_limit() = LimitOrderDefinition{};
+      // Now just build the child template and cache it for future use
+      child_template = &(serv.make_child_template(child_def));
+   }
+   // Default constructed result is successful
+   return {};
+}
+
+// Called in the latency sensitive path, once, when the algo is first launched. 
+// If the Algo is attaching to an existing order do_launch_attached is called instead.
+void MyAlgo::do_launch(IAlgoServices &services) {
+   algo_services = &services;
+   // Subscribe to book updates for this security
+   services.subscribe_book(SecurityKey(services.security().id()));
+   // Launch a child limit order
+   child_key = 
+      services.launch_child(*child_template, services.price(), services.quantity());
+   LOG(Sdk,Info, "MyAlgo: do_launch");
+}
+
+// Called in the latency sensitive path, once, when the algo is first
+// launched. In this case the algo is provided with an existing order
+// it is now responsible for managing.
+void MyAlgo::do_launch_attached(IAlgoServices &services,
+                                OrderKey attached_order, ChildState st) {
+   algo_services = &services;
+   // Subscribe to book updates for this security
+   services.subscribe_book(SecurityKey(services.security().id()));
+   // Keep track of the child key
+   child_key = attached_order;
+   LOG(Sdk,Info, "MyAlgo: do_launch_attached");
+}
+
+// Called when a human (or a supervising algo) updates a parameter for
+// this algo. The implementation validates the update and depending on
+// the validation outcome either applies the update or terminates the algo.
+void MyAlgo::do_update(api::orderman::Update const &update) {
+}
+
+// Called when the book for the specified security has changed
+void MyAlgo::on_book(SecurityKey, Book const &b) {
+}
+
+// Our child reported a change
+void MyAlgo::on_child_change(OrderKey, ChildState const &st) {
+}
+
+// This is called by the spark daemon at startup. In this call we
+// describe our algo's parameters and register a factory function to
+// create an instance of the algo.
+extern "C" void init_spark_plugin(bts::SparkServices &serv) {
+   using namespace bts;
+
+   DynamicOrderDescriptor desc;
+
+   // Start by naming our order type
+   desc.set_dynamic_order_type("My Algo");
+
+   *desc.add_param_desc() = param_bool("Enable Feature");
+   *desc.add_param_desc() = param_uint32("Feature Quantity");
+
+   // Associate the descriptor with a builder function and register
+   // that with the Spark server.
+   auto result = 
+      serv.register_dynamic_algo_order(
+       desc, []() { return std::make_unique<MyAlgo>(); });
+
+   if (result != bts::AlgoRegistrationResult::SUCCESS) {
+      // The desc has errors
+      // Check the error log (/sparkdata/data/logging/log) for more details
+   }
+}
+
+} // namespace order_example
+} // namespace bts
+```

doc/api/deploy_to_web.sh

@@ -0,0 +1,9 @@
+#/bin/bash
+
+# ../../externals/linux/bin/zola/zola build
+zola.exe build
+
+rsync -avzL public/ bts@api.bluetradesys.com:/data/sdk/public/
+
+rm -rf ./public/
+

doc/api/sass/_base.scss

@@ -0,0 +1,97 @@
+html, body {
+  font-size: 16px;
+  height: 100%;
+}
+
+body {
+  font-family: "Source Sans Pro", "Open Sans","Helvetica Neue",Helvetica,Arial,sans-serif;
+  line-height: 1.6;
+  // from http://www.heropatterns.com
+  background-color: #0072a2;
+  background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='100' height='100' viewBox='0 0 100 100'%3E%3Cg fill-rule='evenodd'%3E%3Cg fill='%234b4b4b' fill-opacity='0.4'%3E%3Cpath opacity='.5' d='M96 95h4v1h-4v4h-1v-4h-9v4h-1v-4h-9v4h-1v-4h-9v4h-1v-4h-9v4h-1v-4h-9v4h-1v-4h-9v4h-1v-4h-9v4h-1v-4h-9v4h-1v-4H0v-1h15v-9H0v-1h15v-9H0v-1h15v-9H0v-1h15v-9H0v-1h15v-9H0v-1h15v-9H0v-1h15v-9H0v-1h15v-9H0v-1h15V0h1v15h9V0h1v15h9V0h1v15h9V0h1v15h9V0h1v15h9V0h1v15h9V0h1v15h9V0h1v15h9V0h1v15h4v1h-4v9h4v1h-4v9h4v1h-4v9h4v1h-4v9h4v1h-4v9h4v1h-4v9h4v1h-4v9h4v1h-4v9zm-1 0v-9h-9v9h9zm-10 0v-9h-9v9h9zm-10 0v-9h-9v9h9zm-10 0v-9h-9v9h9zm-10 0v-9h-9v9h9zm-10 0v-9h-9v9h9zm-10 0v-9h-9v9h9zm-10 0v-9h-9v9h9zm-9-10h9v-9h-9v9zm10 0h9v-9h-9v9zm10 0h9v-9h-9v9zm10 0h9v-9h-9v9zm10 0h9v-9h-9v9zm10 0h9v-9h-9v9zm10 0h9v-9h-9v9zm10 0h9v-9h-9v9zm9-10v-9h-9v9h9zm-10 0v-9h-9v9h9zm-10 0v-9h-9v9h9zm-10 0v-9h-9v9h9zm-10 0v-9h-9v9h9zm-10 0v-9h-9v9h9zm-10 0v-9h-9v9h9zm-10 0v-9h-9v9h9zm-9-10h9v-9h-9v9zm10 0h9v-9h-9v9zm10 0h9v-9h-9v9zm10 0h9v-9h-9v9zm10 0h9v-9h-9v9zm10 0h9v-9h-9v9zm10 0h9v-9h-9v9zm10 0h9v-9h-9v9zm9-10v-9h-9v9h9zm-10 0v-9h-9v9h9zm-10 0v-9h-9v9h9zm-10 0v-9h-9v9h9zm-10 0v-9h-9v9h9zm-10 0v-9h-9v9h9zm-10 0v-9h-9v9h9zm-10 0v-9h-9v9h9zm-9-10h9v-9h-9v9zm10 0h9v-9h-9v9zm10 0h9v-9h-9v9zm10 0h9v-9h-9v9zm10 0h9v-9h-9v9zm10 0h9v-9h-9v9zm10 0h9v-9h-9v9zm10 0h9v-9h-9v9zm9-10v-9h-9v9h9zm-10 0v-9h-9v9h9zm-10 0v-9h-9v9h9zm-10 0v-9h-9v9h9zm-10 0v-9h-9v9h9zm-10 0v-9h-9v9h9zm-10 0v-9h-9v9h9zm-10 0v-9h-9v9h9zm-9-10h9v-9h-9v9zm10 0h9v-9h-9v9zm10 0h9v-9h-9v9zm10 0h9v-9h-9v9zm10 0h9v-9h-9v9zm10 0h9v-9h-9v9zm10 0h9v-9h-9v9zm10 0h9v-9h-9v9z'/%3E%3Cpath d='M6 5V0H5v5H0v1h5v94h1V6h94V5H6z'/%3E%3C/g%3E%3C/g%3E%3C/svg%3E");
+
+  color: $foreground;
+
+  // for sticky footer
+  display: flex;
+  flex-direction: column;
+  min-height: 100vh;
+}
+
+a {
+  color: $link-color;
+  text-decoration: none;
+  cursor: pointer;
+  border-bottom: 1px solid rgba(0, 124, 188, 0.25);
+
+  &:hover {
+    border-bottom: 1px solid $link-color;
+  }
+
+  &:visited {
+    color: $link-color;
+  }
+
+  // totally taken from stripe
+  &.button {
+    outline: none;
+    white-space: nowrap;
+    display: inline-block;
+    height: 40px;
+    line-height: 40px;
+    padding: 0 14px;
+    box-shadow: 0 4px 6px rgba(50, 50, 93, 0.11), 0 1px 3px rgba(0, 0, 0, 0.08);
+    background: #fff;
+    border-radius: 4px;
+    font-size: 15px;
+    font-weight: 600;
+    text-transform: uppercase;
+    letter-spacing: .025em;
+    color: #191919;
+    text-decoration: none;
+    transition: all .15s ease;
+    border-bottom: none;
+
+    &:hover {
+      transform: translateY(-1px);
+      text-decoration: none;
+      box-shadow: 0 7px 14px rgba(50, 50, 93, 0.1), 0 3px 6px rgba(0, 0, 0, 0.08);
+    }
+
+    &:active {
+      background-color: #f6f9fc;
+      transform: translateY(1px);
+    }
+  }
+
+  &.white {
+    color: white;
+    border-bottom-color: rgba(255, 255, 255, 0.25);
+
+    &:hover {
+      border-bottom-color: white;
+    }
+
+    &:visited {
+      color: white;
+    }
+  }
+}
+
+pre {
+  padding: 1rem;
+  overflow: auto;
+}
+
+p code, li code {
+  // color: #e6e1dc;
+  // background-color: #383838;
+  color: #191919;
+  background-color: #f5f5f5;
+  white-space: pre-wrap;
+  padding: 3px;
+  border-radius: 3px;
+  font-size: 0.85rem;
+  font-family: monospace;
+  // box-shadow: 0 1px 3px rgba(0,0,0,.1), 0 1px 1px rgba(0,0,0,.1), 0 2px 1px -1px rgba(0,0,0,.12);
+}

doc/api/sass/_docs.scss

@@ -0,0 +1,96 @@
+.documentation {
+  padding: 3rem;
+  display: flex;
+
+  &__sidebar {
+    margin-right: 2rem;
+
+    ul {
+      padding-left: 0;
+      list-style: none;
+    }
+
+    > ul {
+      > li {
+        margin-bottom: 1rem;
+      }
+
+      .documentation__sidebar__title {
+        font-size: 1.25rem;
+        font-weight: bold;
+      }
+
+      ul {
+        margin-top: 0.25rem;
+
+        li {
+          border-left: 1px solid $background;
+          padding-left: 0.75rem;
+          padding-top: 0.25rem;
+          padding-bottom: 0.25rem;
+        }
+
+        li.active a {
+          font-weight: bold;
+          border-bottom: 1px solid $link-color;
+        }
+      }
+    }
+
+  }
+
+  &__content {
+    width: 60%;
+    // Same as the anchor absolute left to not overlap
+    margin-left: 2rem;
+
+    h1, h2, h3, h4, h5, h6 {
+      .zola-anchor {
+        font-size: 1.25rem;
+        visibility: hidden;
+        margin-left: -2rem;
+        text-decoration: none;
+        border-bottom-color: transparent;
+        cursor: pointer;
+      }
+
+      &:hover {
+        .zola-anchor {
+          visibility: visible;
+        }
+      }
+    }
+
+    blockquote {
+      border-left: 10px solid black;
+      padding: 0.25rem 0.5rem;
+      margin-left: 0;
+      font-style: italic;
+    }
+  }
+
+  iframe {
+    width: 100%;
+    min-height: 400px;
+  }
+}
+
+
+@media only screen and (max-width: 1000px) {
+  .documentation {
+    flex-direction: column;
+    padding: 2rem;
+
+    &__content {
+      width: 100%;
+      margin-left: 0;
+    }
+
+    &__sidebar {
+      border-top: 1px solid $background;
+      order: 1;
+      margin-right: 0;
+      margin-top: 1rem;
+    }
+  }
+}

doc/api/sass/_header.scss

@@ -0,0 +1,33 @@
+header {
+  .header__logo {
+    border-bottom: none;
+  }
+
+  nav a {
+    margin-right: 2rem;
+  }
+
+  .header__logo {
+    font-size: 2rem;
+    font-weight: bold;
+
+    &:hover {
+      text-decoration: none;
+    }
+  }
+}
+
+@media only screen and (max-width: 1000px) {
+  header {
+    padding: 1rem 0;
+
+    nav {
+      text-align: center;
+    }
+
+    .header__logo {
+      // to force menu links to be on a line below
+      display: block;
+    }
+  }
+}

doc/api/sass/_index.scss

@@ -0,0 +1,71 @@
+.inverted-colours {
+  background: $foreground;
+  color: $background;
+}
+
+.hero {
+  width: 60%;
+  margin: 0 auto;
+  margin-top: 2rem;
+  margin-bottom: 4rem;
+  text-align: center;
+
+  &__tagline {
+    margin-bottom: 2rem;
+  }
+}
+
+.disabled {
+  opacity: 0.5;
+}
+
+.selling-points {
+  padding: 3rem;
+
+  &__content {
+    display: flex;
+    flex-wrap: wrap;
+  }
+}
+
+.selling-point {
+  // 2 selling points per row on desktop
+  width: 50%;
+  padding: 2rem;
+  padding-top: 1rem;
+}
+
+.selling-header {
+  width: 100%;
+  padding: 1rem;
+  padding-top: 0rem;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  img {
+    align-self: center;
+    max-width: 70%;
+  }
+}
+
+// and 1 on mobile
+@media only screen and (max-width: 1000px) {
+  .hero {
+    width: 90%;
+    margin-top: 2rem;
+    margin-bottom: 4rem;
+  }
+
+  .selling-points {
+    padding: 2rem;
+  }
+
+  .selling-point {
+    width: 100%;
+    padding: 1rem;
+
+    h2 {
+      text-align: center;
+    }
+  }
+}

doc/api/sass/_layout.scss

@@ -0,0 +1,43 @@
+header {
+  padding: 2rem 3rem;
+}
+
+.container {
+  max-width: 1000px;
+  margin: 0 auto;
+}
+
+@media only screen and (max-width: 1000px)  {
+  .container {
+    max-width: 90%;
+  }
+}
+
+.content {
+  flex-grow: 1;
+
+  &--reversed {
+    background: $foreground;
+    color: $background;
+  }
+}
+
+.linux {
+  padding: 25px 15px;
+  background: #eff0f1;
+  border-radius: 5px;
+  border: 1px solid #0072a2;
+}
+
+.info {
+  padding: 25px 15px;
+  background: #ffffe0;
+  border-radius: 5px;
+  border: 1px solid #383838;
+}
+
+
+footer {
+  text-align: center;
+  padding: 2rem 3rem;
+}

doc/api/sass/_normalize.scss

@@ -0,0 +1,447 @@
+/*! normalize.css v7.0.0 | MIT License | github.com/necolas/normalize.css */
+
+/* Document
+   ========================================================================== */
+
+/**
+ * 1. Correct the line height in all browsers.
+ * 2. Prevent adjustments of font size after orientation changes in
+ *    IE on Windows Phone and in iOS.
+ */
+
+html {
+  line-height: 1.15; /* 1 */
+  -ms-text-size-adjust: 100%; /* 2 */
+  -webkit-text-size-adjust: 100%; /* 2 */
+}
+
+/* Sections
+   ========================================================================== */
+
+/**
+ * Remove the margin in all browsers (opinionated).
+ */
+
+body {
+  margin: 0;
+}
+
+/**
+ * Add the correct display in IE 9-.
+ */
+
+article,
+aside,
+footer,
+header,
+nav,
+section {
+  display: block;
+}
+
+/**
+ * Correct the font size and margin on `h1` elements within `section` and
+ * `article` contexts in Chrome, Firefox, and Safari.
+ */
+
+h1 {
+  font-size: 2em;
+  margin: 0.67em 0;
+}
+
+/* Grouping content
+   ========================================================================== */
+
+/**
+ * Add the correct display in IE 9-.
+ * 1. Add the correct display in IE.
+ */
+
+figcaption,
+figure,
+main { /* 1 */
+  display: block;
+}
+
+/**
+ * Add the correct margin in IE 8.
+ */
+
+figure {
+  margin: 1em 40px;
+}
+
+/**
+ * 1. Add the correct box sizing in Firefox.
+ * 2. Show the overflow in Edge and IE.
+ */
+
+hr {
+  box-sizing: content-box; /* 1 */
+  height: 0; /* 1 */
+  overflow: visible; /* 2 */
+}
+
+/**
+ * 1. Correct the inheritance and scaling of font size in all browsers.
+ * 2. Correct the odd `em` font sizing in all browsers.
+ */
+
+pre {
+  font-family: monospace, monospace; /* 1 */
+  font-size: 1em; /* 2 */
+}
+
+/* Text-level semantics
+   ========================================================================== */
+
+/**
+ * 1. Remove the gray background on active links in IE 10.
+ * 2. Remove gaps in links underline in iOS 8+ and Safari 8+.
+ */
+
+a {
+  background-color: transparent; /* 1 */
+  -webkit-text-decoration-skip: objects; /* 2 */
+}
+
+/**
+ * 1. Remove the bottom border in Chrome 57- and Firefox 39-.
+ * 2. Add the correct text decoration in Chrome, Edge, IE, Opera, and Safari.
+ */
+
+abbr[title] {
+  border-bottom: none; /* 1 */
+  text-decoration: underline; /* 2 */
+  text-decoration: underline dotted; /* 2 */
+}
+
+/**
+ * Prevent the duplicate application of `bolder` by the next rule in Safari 6.
+ */
+
+b,
+strong {
+  font-weight: inherit;
+}
+
+/**
+ * Add the correct font weight in Chrome, Edge, and Safari.
+ */
+
+b,
+strong {
+  font-weight: bolder;
+}
+
+/**
+ * 1. Correct the inheritance and scaling of font size in all browsers.
+ * 2. Correct the odd `em` font sizing in all browsers.
+ */
+
+code,
+kbd,
+samp {
+  font-family: monospace, monospace; /* 1 */
+  font-size: 1em; /* 2 */
+}
+
+/**
+ * Add the correct font style in Android 4.3-.
+ */
+
+dfn {
+  font-style: italic;
+}
+
+/**
+ * Add the correct background and color in IE 9-.
+ */
+
+mark {
+  background-color: #ff0;
+  color: #000;
+}
+
+/**
+ * Add the correct font size in all browsers.
+ */
+
+small {
+  font-size: 80%;
+}
+
+/**
+ * Prevent `sub` and `sup` elements from affecting the line height in
+ * all browsers.
+ */
+
+sub,
+sup {
+  font-size: 75%;
+  line-height: 0;
+  position: relative;
+  vertical-align: baseline;
+}
+
+sub {
+  bottom: -0.25em;
+}
+
+sup {
+  top: -0.5em;
+}
+
+/* Embedded content
+   ========================================================================== */
+
+/**
+ * Add the correct display in IE 9-.
+ */
+
+audio,
+video {
+  display: inline-block;
+}
+
+/**
+ * Add the correct display in iOS 4-7.
+ */
+
+audio:not([controls]) {
+  display: none;
+  height: 0;
+}
+
+/**
+ * Remove the border on images inside links in IE 10-.
+ */
+
+img {
+  border-style: none;
+}
+
+/**
+ * Hide the overflow in IE.
+ */
+
+svg:not(:root) {
+  overflow: hidden;
+}
+
+/* Forms
+   ========================================================================== */
+
+/**
+ * 1. Change the font styles in all browsers (opinionated).
+ * 2. Remove the margin in Firefox and Safari.
+ */
+
+button,
+input,
+optgroup,
+select,
+textarea {
+  font-family: sans-serif; /* 1 */
+  font-size: 100%; /* 1 */
+  line-height: 1.15; /* 1 */
+  margin: 0; /* 2 */
+}
+
+/**
+ * Show the overflow in IE.
+ * 1. Show the overflow in Edge.
+ */
+
+button,
+input { /* 1 */
+  overflow: visible;
+}
+
+/**
+ * Remove the inheritance of text transform in Edge, Firefox, and IE.
+ * 1. Remove the inheritance of text transform in Firefox.
+ */
+
+button,
+select { /* 1 */
+  text-transform: none;
+}
+
+/**
+ * 1. Prevent a WebKit bug where (2) destroys native `audio` and `video`
+ *    controls in Android 4.
+ * 2. Correct the inability to style clickable types in iOS and Safari.
+ */
+
+button,
+html [type="button"], /* 1 */
+[type="reset"],
+[type="submit"] {
+  -webkit-appearance: button; /* 2 */
+}
+
+/**
+ * Remove the inner border and padding in Firefox.
+ */
+
+button::-moz-focus-inner,
+[type="button"]::-moz-focus-inner,
+[type="reset"]::-moz-focus-inner,
+[type="submit"]::-moz-focus-inner {
+  border-style: none;
+  padding: 0;
+}
+
+/**
+ * Restore the focus styles unset by the previous rule.
+ */
+
+button:-moz-focusring,
+[type="button"]:-moz-focusring,
+[type="reset"]:-moz-focusring,
+[type="submit"]:-moz-focusring {
+  outline: 1px dotted ButtonText;
+}
+
+/**
+ * Correct the padding in Firefox.
+ */
+
+fieldset {
+  padding: 0.35em 0.75em 0.625em;
+}
+
+/**
+ * 1. Correct the text wrapping in Edge and IE.
+ * 2. Correct the color inheritance from `fieldset` elements in IE.
+ * 3. Remove the padding so developers are not caught out when they zero out
+ *    `fieldset` elements in all browsers.
+ */
+
+legend {
+  box-sizing: border-box; /* 1 */
+  color: inherit; /* 2 */
+  display: table; /* 1 */
+  max-width: 100%; /* 1 */
+  padding: 0; /* 3 */
+  white-space: normal; /* 1 */
+}
+
+/**
+ * 1. Add the correct display in IE 9-.
+ * 2. Add the correct vertical alignment in Chrome, Firefox, and Opera.
+ */
+
+progress {
+  display: inline-block; /* 1 */
+  vertical-align: baseline; /* 2 */
+}
+
+/**
+ * Remove the default vertical scrollbar in IE.
+ */
+
+textarea {
+  overflow: auto;
+}
+
+/**
+ * 1. Add the correct box sizing in IE 10-.
+ * 2. Remove the padding in IE 10-.
+ */
+
+[type="checkbox"],
+[type="radio"] {
+  box-sizing: border-box; /* 1 */
+  padding: 0; /* 2 */
+}
+
+/**
+ * Correct the cursor style of increment and decrement buttons in Chrome.
+ */
+
+[type="number"]::-webkit-inner-spin-button,
+[type="number"]::-webkit-outer-spin-button {
+  height: auto;
+}
+
+/**
+ * 1. Correct the odd appearance in Chrome and Safari.
+ * 2. Correct the outline style in Safari.
+ */
+
+[type="search"] {
+  -webkit-appearance: textfield; /* 1 */
+  outline-offset: -2px; /* 2 */
+}
+
+/**
+ * Remove the inner padding and cancel buttons in Chrome and Safari on macOS.
+ */
+
+[type="search"]::-webkit-search-cancel-button,
+[type="search"]::-webkit-search-decoration {
+  -webkit-appearance: none;
+}
+
+/**
+ * 1. Correct the inability to style clickable types in iOS and Safari.
+ * 2. Change font properties to `inherit` in Safari.
+ */
+
+::-webkit-file-upload-button {
+  -webkit-appearance: button; /* 1 */
+  font: inherit; /* 2 */
+}
+
+/* Interactive
+   ========================================================================== */
+
+/*
+ * Add the correct display in IE 9-.
+ * 1. Add the correct display in Edge, IE, and Firefox.
+ */
+
+details, /* 1 */
+menu {
+  display: block;
+}
+
+/*
+ * Add the correct display in all browsers.
+ */
+
+summary {
+  display: list-item;
+}
+
+/* Scripting
+   ========================================================================== */
+
+/**
+ * Add the correct display in IE 9-.
+ */
+
+canvas {
+  display: inline-block;
+}
+
+/**
+ * Add the correct display in IE.
+ */
+
+template {
+  display: none;
+}
+
+/* Hidden
+   ========================================================================== */
+
+/**
+ * Add the correct display in IE 10-.
+ */
+
+[hidden] {
+  display: none;
+}

doc/api/sass/_search.scss

@@ -0,0 +1,47 @@
+.search-container {
+  display: inline-block;
+  position: relative;
+  width: 300px;
+
+  input {
+    width: 100%;
+    padding: 0.5rem;
+  }
+}
+
+.search-results {
+  display: none;
+  position: absolute;
+  background: white;
+  color: black;
+  padding: 1rem;
+  box-shadow: 2px 2px 2px 0 rgba(0, 0, 0, 0.5);
+  max-height: 500px;
+  overflow: auto;
+  width: 150%;
+  right: 0;
+
+  &__items {
+    list-style: none;
+  }
+
+  li {
+    margin-top: 1rem;
+    border-bottom: 1px solid #ccc;
+    font-size: 0.9rem;
+
+    &:first-of-type {
+      margin-top: 0;
+    }
+  }
+
+  &__item {
+    margin-bottom: 1rem;
+
+    a {
+      font-size: 1.2rem;
+      display: inline-block;
+      margin-bottom: 0.5rem;
+    }
+  }
+}

doc/api/sass/_themes.scss

@@ -0,0 +1,79 @@
+
+.themes-container {
+  padding: 3rem;
+  width: 80%;
+  margin: 0 auto;
+
+  img {
+    max-width: 100%;
+  }
+}
+
+@media only screen and (max-width: 1000px)  {
+  .themes-container {
+    width: 100%;
+    margin: 0 1rem;
+  }
+}
+
+.themes {
+  display: flex;
+  flex-wrap: wrap;
+  justify-content: space-between;
+
+  .theme {
+    width: 45%;
+    text-decoration: none;
+    cursor: pointer;
+    margin-bottom: 2rem;
+    border-bottom: none;
+    box-shadow: 0 1px 2px rgba(0, 0, 0, 0.4);
+    padding: 10px;
+
+    img {
+      width: 100%;
+      height: 90%;
+    }
+
+    span {
+      display: block;
+      text-align: center;
+      font-size: 1.1rem;
+    }
+  }
+}
+
+.theme-info {
+  display: flex;
+  align-items: flex-start;
+
+  .thumb {
+    box-shadow: 0 1px 2px rgba(0, 0, 0, 0.07);
+    width: 400px;
+    margin-right: 2rem;
+  }
+
+  h1, p {
+    margin: 0;
+  }
+
+  padding: 1rem;
+}
+
+
+@media only screen and (max-width: 1000px)  {
+  .themes .theme {
+    width: 100%;
+  }
+}
+
+@media only screen and (max-width: 1000px)  {
+  .theme-info {
+    flex-direction: column;
+    align-items: center;
+
+    img {
+      margin-bottom: 1rem;
+    }
+  }
+}

doc/api/sass/site.scss

@@ -0,0 +1,19 @@
+@charset "utf-8";
+
+@import "normalize";
+
+*, *:before, *:after {
+  box-sizing: border-box;
+}
+
+$background: #191919;
+$foreground: white;
+$link-color: #007CBC;
+
+@import "base";
+@import "layout";
+@import "header";
+@import "index";
+@import "docs";
+@import "themes";
+@import "search";

doc/api/static/images/logo.svg

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg enable-background="new 0 0 523.438 166.055" version="1.1" viewBox="0 0 523.44 166.06" xmlns="http://www.w3.org/2000/svg"><path d="m297.43 153.29c-18.051-6.698-91.506-40.523-160.87-72.832-69.291-32.28-134.17-62.929-134.17-62.929-2.082-0.983-2.971-3.466-1.987-5.549 0.981-2.079 3.466-2.97 5.548-1.988 0.037 0.02 16.216 7.661 41.09 19.354 24.874 11.695 58.412 27.425 93.046 43.557 69.192 32.242 143.09 66.232 160.25 72.574 20.188 7.443 37.922 12.204 80.113 12.239 30.434 0 73.407-2.559 138.44-8.568 2.288-0.211 4.319 1.474 4.531 3.765 0.208 2.29-1.478 4.324-3.771 4.536-65.152 6.014-108.31 8.602-139.2 8.605h-0.423c-42.393-1e-3 -61.964-5.092-82.59-12.764z" fill="#B3B3B3"/><path d="m45.824 145.9v-138.39h101.28c27.03 0 44.924 12.184 44.924 35.789 0 17.513-8.947 26.27-19.226 29.506 12.564 3.996 21.702 15.039 21.702 31.22 0 25.319-17.516 41.88-44.545 41.88h-104.13zm41.692-60.155v-20.37h59.774c13.707 0 20.179-4.758 20.179-16.751 0-14.658-11.613-16.943-29.507-16.943h-67.96v90.234h70.052c17.325 0 29.889-4.759 29.889-18.276 0-11.423-7.423-17.894-20.939-17.894h-61.488z" fill="#0086BF"/><path d="m149.96 153.4h-104.13v-7.502h7.501-7.501v7.502h-7.504v-153.4h108.78c14.604 0.018 27.473 3.236 37.154 10.583 9.724 7.301 15.384 19.035 15.273 32.71 0.018 10.01-2.623 18.337-7.222 24.554-1.308 1.779-2.755 3.368-4.306 4.774 2.395 1.964 4.557 4.235 6.422 6.792 4.847 6.626 7.594 15.107 7.58 24.606 0.044 14.363-5.105 27.096-14.494 35.896-9.347 8.809-22.486 13.486-37.463 13.486-0.028 1e-3 -0.058 1e-3 -0.088 1e-3zm0-15.007c12.016-0.018 21.114-3.62 27.266-9.402 6.125-5.814 9.736-14.02 9.777-24.973-0.015-6.687-1.835-11.817-4.698-15.757-2.875-3.934-6.891-6.753-11.775-8.315l-22.267-7.085c-0.322 7e-3 -0.645 0.011-0.97 0.012h-52.271v5.367h53.988c7.892 0 15.036 1.876 20.422 6.475 5.429 4.589 8.092 11.651 8.015 18.922 0.016 4.524-1.103 8.88-3.35 12.497-2.236 3.632-5.46 6.38-9.02 8.3-7.172 3.825-15.677 4.938-25.019 4.979h-77.553v-105.24h75.46c6.958 0.014 13.253 0.288 19.035 1.724 5.677 1.383 11.425 4.37 14.807 10.025 2.23 3.702 3.174 8.068 3.171 12.698-5e-3 3.663-0.489 7.129-1.729 10.368-1.045 2.753-2.714 5.301-4.853 7.329l2.154-0.677c3.906-1.243 7.213-3.358 9.68-6.692 2.445-3.351 4.276-8.156 4.297-15.657-0.111-9.936-3.399-16.094-9.377-20.786-6.028-4.645-15.62-7.52-28.046-7.501l-93.773-3e-3v123.39h96.629v-1e-3zm-72.453-23.984h62.551c5.981 0.011 11.112-0.651 14.744-1.85 3.688-1.218 5.575-2.753 6.528-4.306 0.647-1.077 1.099-2.388 1.113-4.618-0.073-4.151-1.124-6.039-2.785-7.541-1.701-1.492-5.034-2.853-10.648-2.853h-61.49v-7.501h7.501-7.501v7.501h-7.504v-35.372h67.277c4.502 0.018 7.602-0.643 9.234-1.431 1.634-0.854 2.056-1.329 2.718-2.838 0.402-1.025 0.728-2.648 0.728-4.979-0.01-2.704-0.518-4.121-1.023-4.967-0.526-0.837-1.154-1.457-2.696-2.209-3.023-1.521-9.667-2.335-18.288-2.268h-60.459v75.232z" fill="#fff"/><path d="M251.22,145.899V31.68h-52.54V7.505h129.256V31.68h-52.539v114.22H251.22z" fill="#0086BF"/><path d="m251.22 153.4v-7.499h7.501-7.501v7.499h-7.504l-2e-3 -114.22h-52.538v-39.175h144.26v39.175h-52.541v114.22h-31.678zm16.673-15.001v-114.22h52.538v-9.171h-114.25v9.171h52.542v114.22h9.171v-1e-3z" fill="#fff"/><path d="m340.11 145.9v-24.176h103.74c12.942 0 20.177-7.233 20.177-18.083 0-11.802-7.234-17.893-20.177-17.893h-63.58c-26.075 0-42.257-16.562-42.257-39.404 0-22.271 15.038-38.831 42.639-38.831h99.365v24.174h-99.365c-11.042 0-17.514 6.473-17.514 16.94 0 10.469 6.661 16.751 17.324 16.751h63.388c27.98 0 43.02 13.134 43.02 39.974 0 23.226-14.089 40.546-43.02 40.546h-103.74z" fill="#383431"/><path d="m443.85 153.4h-103.74v-7.499h7.498-7.498v7.499h-7.505v-39.176h111.25c5.118-0.02 8.116-1.385 9.849-2.984 1.71-1.622 2.774-3.8 2.823-7.597-0.071-4.45-1.162-6.342-2.67-7.727-1.55-1.385-4.646-2.668-10.002-2.668h-63.58c-14.603 0.028-27.235-4.711-36.097-13.218-8.89-8.476-13.698-20.511-13.666-33.685-0.032-12.792 4.428-24.712 13.274-33.177 8.826-8.496 21.605-13.184 36.87-13.155h106.86v39.176h-106.86c-4.11 0.028-6.327 1.125-7.658 2.411-1.313 1.309-2.315 3.29-2.354 7.027 0.043 3.691 1.042 5.592 2.354 6.89 1.338 1.278 3.562 2.338 7.469 2.36h63.388c15.081-7e-3 27.896 3.536 37.065 11.888 9.185 8.367 13.511 20.865 13.455 35.59 0.022 13.078-4.037 25.357-12.824 34.248-8.729 8.882-21.678 13.796-37.497 13.796-0.066 1e-3 -0.135 1e-3 -0.2 1e-3zm-96.246-14.999 96.246-4e-3c13.017-0.037 21.505-3.779 27.018-9.329 5.488-5.576 8.475-13.569 8.494-23.712-0.052-12.118-3.246-19.606-8.572-24.519-5.35-4.923-14.046-7.951-26.939-7.956h-63.388c-6.76 0.022-13.199-2.056-17.858-6.541-4.686-4.459-7.014-10.932-6.972-17.712-0.038-6.729 2.191-13.218 6.88-17.764 4.659-4.564 11.2-6.707 18.14-6.678h91.856v-9.174l-91.856 4e-3c-12.341 0.026-20.88 3.617-26.474 8.971-5.574 5.382-8.632 12.875-8.667 22.358 0.035 9.665 3.317 17.334 9.038 22.85 5.746 5.486 14.244 9.029 25.721 9.049h63.58c7.58 0 14.573 1.767 19.88 6.38 5.34 4.606 7.87 11.665 7.799 19.018 0.048 7.05-2.504 13.916-7.652 18.62-5.117 4.73-12.205 6.982-20.026 6.965l-96.246-6e-3v9.18h-2e-3z" fill="#fff"/><path d="m45.824 145.9v-138.39h101.27c6Line truncated

doc/api/static/search.js

@@ -0,0 +1,180 @@
+function debounce(func, wait) {
+  var timeout;
+
+  return function () {
+    var context = this;
+    var args = arguments;
+    clearTimeout(timeout);
+
+    timeout = setTimeout(function () {
+      timeout = null;
+      func.apply(context, args);
+    }, wait);
+  };
+}
+
+// Taken from mdbook
+// The strategy is as follows:
+// First, assign a value to each word in the document:
+//  Words that correspond to search terms (stemmer aware): 40
+//  Normal words: 2
+//  First word in a sentence: 8
+// Then use a sliding window with a constant number of words and count the
+// sum of the values of the words within the window. Then use the window that got the
+// maximum sum. If there are multiple maximas, then get the last one.
+// Enclose the terms in <b>.
+function makeTeaser(body, terms) {
+  var TERM_WEIGHT = 40;
+  var NORMAL_WORD_WEIGHT = 2;
+  var FIRST_WORD_WEIGHT = 8;
+  var TEASER_MAX_WORDS = 30;
+
+  var stemmedTerms = terms.map(function (w) {
+    return elasticlunr.stemmer(w.toLowerCase());
+  });
+  var termFound = false;
+  var index = 0;
+  var weighted = []; // contains elements of ["word", weight, index_in_document]
+
+  // split in sentences, then words
+  var sentences = body.toLowerCase().split(". ");
+
+  for (var i in sentences) {
+    var words = sentences[i].split(" ");
+    var value = FIRST_WORD_WEIGHT;
+
+    for (var j in words) {
+      var word = words[j];
+
+      if (word.length > 0) {
+        for (var k in stemmedTerms) {
+          if (elasticlunr.stemmer(word).startsWith(stemmedTerms[k])) {
+            value = TERM_WEIGHT;
+            termFound = true;
+          }
+        }
+        weighted.push([word, value, index]);
+        value = NORMAL_WORD_WEIGHT;
+      }
+
+      index += word.length;
+      index += 1;  // ' ' or '.' if last word in sentence
+    }
+
+    index += 1;  // because we split at a two-char boundary '. '
+  }
+
+  if (weighted.length === 0) {
+    return body;
+  }
+
+  var windowWeights = [];
+  var windowSize = Math.min(weighted.length, TEASER_MAX_WORDS);
+  // We add a window with all the weights first
+  var curSum = 0;
+  for (var i = 0; i < windowSize; i++) {
+    curSum += weighted[i][1];
+  }
+  windowWeights.push(curSum);
+
+  for (var i = 0; i < weighted.length - windowSize; i++) {
+    curSum -= weighted[i][1];
+    curSum += weighted[i + windowSize][1];
+    windowWeights.push(curSum);
+  }
+
+  // If we didn't find the term, just pick the first window
+  var maxSumIndex = 0;
+  if (termFound) {
+    var maxFound = 0;
+    // backwards
+    for (var i = windowWeights.length - 1; i >= 0; i--) {
+      if (windowWeights[i] > maxFound) {
+        maxFound = windowWeights[i];
+        maxSumIndex = i;
+      }
+    }
+  }
+
+  var teaser = [];
+  var startIndex = weighted[maxSumIndex][2];
+  for (var i = maxSumIndex; i < maxSumIndex + windowSize; i++) {
+    var word = weighted[i];
+    if (startIndex < word[2]) {
+      // missing text from index to start of `word`
+      teaser.push(body.substring(startIndex, word[2]));
+      startIndex = word[2];
+    }
+
+    // add <em/> around search terms
+    if (word[1] === TERM_WEIGHT) {
+      teaser.push("<b>");
+    }
+    startIndex = word[2] + word[0].length;
+    teaser.push(body.substring(word[2], startIndex));
+
+    if (word[1] === TERM_WEIGHT) {
+      teaser.push("</b>");
+    }
+  }
+  teaser.push("…");
+  return teaser.join("");
+}
+
+function formatSearchResultItem(item, terms) {
+  return '<div class="search-results__item">'
+  + `<a href="${item.ref}">${item.doc.title}</a>`
+  + `<div>${makeTeaser(item.doc.body, terms)}</div>`
+  + '</div>';
+}
+
+function initSearch() {
+  var $searchInput = document.getElementById("search");
+  var $searchResults = document.querySelector(".search-results");
+  var $searchResultsItems = document.querySelector(".search-results__items");
+  var MAX_ITEMS = 10;
+
+  var options = {
+    bool: "AND",
+    fields: {
+      title: {boost: 2},
+      body: {boost: 1},
+    }
+  };
+  var currentTerm = "";
+  var index = elasticlunr.Index.load(window.searchIndex);
+
+  $searchInput.addEventListener("keyup", debounce(function() {
+    var term = $searchInput.value.trim();
+    if (term === currentTerm || !index) {
+      return;
+    }
+    $searchResults.style.display = term === "" ? "none" : "block";
+    $searchResultsItems.innerHTML = "";
+    if (term === "") {
+      return;
+    }
+
+    var results = index.search(term, options);
+    if (results.length === 0) {
+      $searchResults.style.display = "none";
+      return;
+    }
+
+    currentTerm = term;
+    for (var i = 0; i < Math.min(results.length, MAX_ITEMS); i++) {
+      var item = document.createElement("li");
+      item.innerHTML = formatSearchResultItem(results[i], term.split(" "));
+      $searchResultsItems.appendChild(item);
+    }
+  }, 150));
+}
+
+
+if (document.readyState === "complete" ||
+    (document.readyState !== "loading" && !document.documentElement.doScroll)
+) {
+  initSearch();
+} else {
+  document.addEventListener("DOMContentLoaded", initSearch);
+}

doc/api/templates/client.html

@@ -0,0 +1,31 @@
+{% extends "index.html" %}
+
+{% block extra_nav_class %}{% endblock extra_nav_class %}
+{% block extra_content_class %}content--reversed{% endblock extra_content_class %}
+
+{% block content %}
+{% set section = get_section(path="client/_index.md") %}
+<div class="documentation">
+    <aside class="documentation__sidebar">
+        <ul>
+        {% for p in section.subsections %}
+            {% set subsection = get_section(path=p) %}
+            <li>
+                <span class="documentation__sidebar__title">{{ subsection.title }}</span>
+                <ul>
+                    {% for page in subsection.pages %}
+                        <li class="{% if current_path == page.path %}active{% endif %}">
+                            <a href="{{page.permalink}}">{{page.title}}</a>
+                        </li>
+                    {% endfor %}
+                </ul>
+            </li>
+        {% endfor %}
+        </ul>
+    </aside>
+    <div class="documentation__content">
+        {% block doc_content %}
+        {% endblock doc_content %}
+    </div>
+</div>
+{% endblock content %}

doc/api/templates/documentation.html

@@ -0,0 +1,36 @@
+{% extends "index.html" %}
+
+{% block extra_nav_class %}{% endblock extra_nav_class %}
+{% block extra_content_class %}content--reversed{% endblock extra_content_class %}
+
+{% block content %}
+{%if page.extra.section %}
+{% set section = get_section(path="{{page.extra.section}}/_index.md") %}
+{% else %}
+{% set section = get_section(path="server/_index.md") %}
+{% endif %}
+<div class="documentation">
+    <aside class="documentation__sidebar">
+        <ul>
+        {% for p in section.subsections %}
+            {% set subsection = get_section(path=p) %}
+            <li>
+                <span class="documentation__sidebar__title">{{ subsection.title }}</span>
+                <ul>
+                    {% for page in subsection.pages %}
+                        <li class="{% if current_path == page.path %}active{% endif %}">
+                            <a href="{{page.permalink}}">{{page.title}}</a>
+                        </li>
+                    {% endfor %}
+                </ul>
+            </li>
+        {% endfor %}
+        </ul>
+    </aside>
+    <div class="documentation__content">
+        {% block doc_content %}
+        {% endblock doc_content %}
+        {% block next_link %} {% endblock next_link %}
+    </div>
+</div>
+{% endblock content %}

doc/api/templates/index.html

@@ -0,0 +1,101 @@
+<!DOCTYPE html>
+<html lang="en-gb">
+    <head>
+        <meta charset="UTF-8">
+        <meta http-equiv="X-UA-Compatible" content="IE=edge">
+        <meta name="apple-mobile-web-app-capable" content="yes">
+        <link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600" rel="stylesheet" />
+        <meta name="viewport" content="width=device-width, initial-scale=1">
+        <meta name="description" content="{% block description %}{{ config.description }}{% endblock description %}">
+        <meta name="keywords" content="Futures, Options, Derivatives, Trade, Trading, Professional, options trading, futures trading, Software, API, SDK" />
+        <meta name="rights" content="© Blue Trading Systems" />
+        <meta name="author" content="{{ config.extra.author }}">
+        <title>{% block title %}{{ config.title }}{% endblock title %}</title>
+        <link rel="stylesheet" href="{{ get_url(path="site.css") }}"/>
+        <link rel="icon" href="{{ get_url(path="favicon.ico") }}">
+        <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
+    </head>
+    <body>
+
+        <header>
+            <nav class="{% block extra_nav_class %}container{% endblock extra_nav_class %}">
+                <a class="header__logo white" href="{{ config.base_url }}">
+                    <img width="100" src="/images/logo.svg">
+                </a>
+                <a class="white" href="{{ get_url(path="@/server/_index.md") }}" class="nav-link">Server SDK</a>
+                <a class="white" href="{{ get_url(path="@/client/_index.md") }}" class="nav-link">Client SDK</a>
+                <a class="white" href="https://www.bluetradingsystems.com/bts-spark" class="nav-link">About Spark</a>
+
+                <div class="search-container">
+                    <input id="search" type="search" placeholder="🔎 Search">
+
+                    <div class="search-results">
+                        <div class="search-results__items"></div>
+                    </div>
+                </div>
+            </nav>
+        </header>
+
+        <div class="content {% block extra_content_class %}{% endblock extra_content_class %}">
+            {% block content %}
+                <div class="hero">
+                    <h1>Spark SDK</h1>
+                    <p class="hero__tagline">
+                        Spark consists of a client UI 
+                        (<a class="white" href="https://www.bluetradingsystems.com/bts-spark#ladder-algo-screen">Spark Client</a>), 
+                        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.
+                        Use the Spark SDK to extend Spark Server with your custom Algos, then use the Client SDK to launch and control them.
+                    </p>
+                </div>
+
+                <div class="inverted-colours selling-points">
+                    <div class="selling-points__content container">
+                        <div class="selling-header">
+                            <img src="/images/API.png" width="100%" />
+                        </div>
+                        <div class="selling-point">
+                            <h2>
+                                Server SDK 
+                                <i class="fa fa-tachometer" aria-hidden="true"></i>
+                            </h2>
+                            <p>
+                                Leverage the ultra-low latency Spark C++ API to develop and run your custom Algo.  Have your first sub-10 microsecond trading algorithm running in under an hour.
+                            </p>
+                            <a href="{{ get_url(path="@/server/_index.md") }}" class="button">Get started</a>
+                        </div>
+
+                        <div class="selling-point disabled">
+                            <h2>
+                                Client SDK
+                                <i class="fa fa-gamepad" aria-hidden="true"></i>
+                            </h2>
+                            <p>
+                                The Spark client SDK allows you to integrate spark with your existing ecosystem. The Spark Client is built entirely on this simple, powerful API.
+                            </p>
+                            <a href="" class="button" disabled>Get started</a>
+                        </div>
+                        
+                        <!-- <div class="selling-point disabled">
+                            <h2>
+                                Microsoft Excel
+                                <i class="fa fa-table" aria-hidden="true"></i>
+                            </h2>
+                            <p>
+                                More of your business is built on excel than probably should be. Continue this worrying trend with the Spark Excel API.
+                            </p>
+                            <a href="" class="button" disabled>Get started</a>
+                        </div> -->
+                    </div>
+                </div>
+
+            {% endblock content %}
+        </div>
+        <footer>
+            © Blue Trading Systems
+        </footer>
+
+        <script type="text/javascript" src="{{ get_url(path="elasticlunr.min.js") }}"></script>
+        <script type="text/javascript" src="{{ get_url(path="search_index.en.js") }}"></script>
+        <script type="text/javascript" src="{{ get_url(path="search.js") }}"></script>
+    </body>
+</html>

doc/api/templates/page.html

@@ -0,0 +1,25 @@
+{% extends "documentation.html" %}
+
+{% block title %}{{ page.title }} | {{ super() }} {% endblock title %}
+{% block doc_content %}
+    <h1>{{page.title}}</h1>
+    {{page.content | safe}}
+{% endblock doc_content %}
+
+{% block next_link %}
+<p>
+    {% if page.lighter %}
+        <a href="{{ page.lighter.permalink }}">
+            <i class="fa fa-chevron-left fa-fw" aria-hidden="true"></i>
+            Previous
+        </a>
+    {% endif %}
+    &nbsp;
+    {% if page.heavier %}
+        <a href="{{ page.heavier.permalink }}">
+            Next
+            <i class="fa fa-chevron-right fa-fw" aria-hidden="true"></i>
+        </a>
+    {% endif %}
+</p>
+{% endblock next_link %}

doc/api/templates/shortcodes/clipable.html

@@ -0,0 +1,15 @@
+<pre 
+   {% if background %}
+   style="background-color:{{background}};"
+   {% else %}
+   style="background-color:#383838;"
+   {% endif %}
+   >
+<span 
+   {% if color %}
+   style="color:{{color}};"
+   {% else %}
+   style="color:#e6e1dc;"
+   {% endif %}
+><a onclick="navigator.clipboard.writeText('{{body}}')"><i class="fa fa-clipboard fa-underline" style="color: white; text-decoration: none;"></i></a> {{body}}</span>
+</pre>

doc/api/templates/shortcodes/gallery.html

@@ -0,0 +1,7 @@
+{% for asset in page.assets -%}
+  {%- if asset is matching("[.](jpg|png)$") -%}
+    <a href="{{ get_url(path=asset) | safe }}" target="_blank">
+      <img src="{{ resize_image(path=asset, width=240, height=180, op="fill", format="auto") | safe }}" />
+    </a>
+  {%- endif %}
+{%- endfor %}

doc/api/templates/shortcodes/info.html

@@ -0,0 +1,4 @@
+<div class="info">
+<i class="fa fa-lightbulb-o fa-fw" aria-hidden="true"></i>
+    {{body}}
+</div>

doc/api/templates/shortcodes/linux.html

@@ -0,0 +1,4 @@
+<div class="linux">
+    <i class="fa fa-linux fa-fw" aria-hidden="true"></i>
+    {{body}}
+</div>

doc/api/templates/shortcodes/resize_image.html

@@ -0,0 +1 @@
+<img src="{{ resize_image(path=path, width=width, height=height, op=op) }}" />

doc/user/content/release_notes/_index.md

@@ -4,6 +4,17 @@ weight = 3
 sort_by = "weight"
 insert_anchor_links = "right"
 +++
+## 2.14.0
+### User Visible Changes  
+  - All ladders can now be recentered by (shift or alt) + double clicking over the Price column in a ladder
+  - Added a Max Order Quantity setting to the Safety Checks tab on the Ladder settings. This setting allows for a user-defined maximum order quantity.
+  - Added a Price Display Format setting to the Market Price and Size Display tab on the Ladder settings. This setting allows for price levels in the ladder to be displayed without a decimal separator.
+  - Synthetic instrument creation with 3 legs no longer defaults to butterfly quantites
+### Bug Fixes
+  - Fixed an issue where market transition were not observed by IAlgoOrder
+  - Fixed a bug in error reporting
+  - Fixed a bug in the PnL window where specifying a certain grouping order would lead to a UI failure
+
 ## 2.13.0
 ### User Visible Changes  
   - Added the name of the spreader to the parent algo badge (for spreader child orders), in the fills, orderbook and floating orderbook windows

ops_notes.txt

@@ -1,3 +1,7 @@
+2.14.0
+- Load Algos in libspark.so automatically (no symlink needed)
+- Specify commands to run when sparkd starts. These will automatically be killed when sparkd terminates if they are still running.
+
 1.5.7
 - Fixed Aggressor coloring and ladder high/low coloring in SIM
 

src/client/spark/App.xaml.cs

@@ -136,8 +136,11 @@ namespace mbts.ui.shell
          try {            
             if (argv.Contains("-multiple") || _mutex == null || _mutex.WaitOne(TimeSpan.Zero, true)) 
             {
-               if(_mutex == null || _mutex.WaitOne(TimeSpan.Zero, true))
-                  init_stunnel(argv);
+               if(_mutex == null || _mutex.WaitOne(TimeSpan.Zero, true)) {
+                  if (!argv.Contains("-nostunnel")) {
+                     init_stunnel(argv);
+                  }
+               }
                return base.Run();
             }
             else {

src/client/spark/Modules/Spreader/VM/SyntheticEditorVM.cs

@@ -357,19 +357,13 @@ namespace mbts.spark {
          if (leg_tuples.Count == 2) {
             _is_setting_price_mults = true;
             _price_mult_model.override_value(leg_tuples[1], -1);
-         } else if (leg_tuples.Count == 3) {
-            _is_setting_price_mults = true;
-            _price_mult_model.override_value(leg_tuples[1], -2);
-         }
+         } 
       }
 
       void _deduce_quantities() {
          if (leg_tuples.Count == 2) {
             _is_setting_quantities = true;
             _quantity_model.override_value(leg_tuples[1], -1);
-         } else if (leg_tuples.Count == 3) {
-            _is_setting_quantities = true;
-            _quantity_model.override_value(leg_tuples[1], -2);
          }
       }
 

src/client/spark/Modules/Trading/Ladder/LadderSettings.cs

@@ -249,6 +249,7 @@ namespace mbts.spark {
       const double _default_order_entry_panel_width = 110.0;
       const double _default_zoom_factor = 1.0;
       const bool _default_show_warn_on_cross = true;
+      const bool _default_enforce_max_clip = false;
       public static readonly IEqualityComparer<LadderSettings> profile_equality_comparer =
          EqualityComparer.Create<LadderSettings>(profile_equals);
       // this class is 100% mutable (there are literally 0 readonly members),
@@ -282,6 +283,7 @@ namespace mbts.spark {
          use_defaults = true;
          favorite_algos = new LadderFavoriteAlgosSettings(null, 2, null);
          show_warn_on_cross = _default_show_warn_on_cross;
+         enforce_max_clip = _default_enforce_max_clip;
       }
 
       public static LadderSettings Default {
@@ -347,6 +349,8 @@ namespace mbts.spark {
                zoom_factor = _default_zoom_factor,
                net_change = NetChangeTerms.None,
                mini_ob = new LadderMiniOrderBookSettings(bts.shell.orderbook.OrderBookStartupData.default_mini_grid.general),
+               max_clip = 0,
+               price_display_format = PriceDisplayFormat.Default,
             };
             rv.row_height = LadderRender.measure_row_height(rv);
             return rv;
@@ -365,6 +369,13 @@ namespace mbts.spark {
          Ticks
       }
 
+      public enum PriceDisplayFormat {
+         [Description("Default")]
+         Default,
+         [Description("Integer")]
+         Integer
+      }
+
       [ProtoMember(1)]
       public double row_height { get; set; }
       [ProtoMember(2)]
@@ -499,6 +510,15 @@ namespace mbts.spark {
       [ProtoMember(57)]
       public double left_panel_scroll_position { get; set; }
 
+      [ProtoMember(58), DefaultValue(_default_enforce_max_clip)]
+      public bool enforce_max_clip { get; set; }
+
+      [ProtoMember(59)]
+      public uint max_clip { get; set; }
+
+      [ProtoMember(60)]
+      public PriceDisplayFormat price_display_format { get; set; }
+
       public void sanitize() =>
          sanitize(this);
 
@@ -600,7 +620,10 @@ namespace mbts.spark {
          a.favorite_algos == b.favorite_algos &&
          a.net_change == b.net_change &&
          a.show_warn_on_cross == b.show_warn_on_cross &&
-         a.mini_ob == b.mini_ob;
+         a.mini_ob == b.mini_ob &&
+         a.enforce_max_clip == b.enforce_max_clip &&
+         a.max_clip == b.max_clip &&
+         a.price_display_format == b.price_display_format;
 
       public bool Equals(LadderSettings other) =>
          profile_equals(this, other) &&

src/client/spark/Modules/Trading/Ladder/VM/LadderSettingsVM.cs

@@ -29,7 +29,7 @@ using TextUtils = mbts.ui.utility.text.TextUtils;
 namespace mbts.spark {
    class LadderSettingsVM : DisposableViewModelBase, IWindowSettingsVM<LadderSettings>, IValueFactory<LadderSettings>, IObservable<LadderSettings>, ITemplateSelectorKey {
       readonly Property<LadderSettings.BadgeStyle> _badge_style;
-      readonly Property<uint> _alternate_order_size;
+      readonly Property<uint> _alternate_order_size, _max_clip;
       readonly DelegateProperty<double> _row_height;
       readonly UserProperty<AccountTuple?> _default_account;
       readonly UserProperty<AlgoDefinitionVM> _default_algo;
@@ -41,8 +41,9 @@ namespace mbts.spark {
       AlgoID? _desired_algo;
       TimeInForce _default_time_in_force;
       LadderSettings.NetChangeTerms _price_format;
+      LadderSettings.PriceDisplayFormat _price_display_format;
       double _order_entry_panel_width, _zoom_factor;
-      bool _auto_clear, _show_warn_on_cross;
+      bool _auto_clear, _show_warn_on_cross, _enforce_max_clip;
       LadderSettings _current;
       LadderColumnSettingsVM
          _orders = new OrdersColumnSettingsVM(),
@@ -91,6 +92,7 @@ namespace mbts.spark {
          _alternate_order_size = backing<uint>(nameof(alternate_order_size));
          _default_account = user_backing<AccountTuple?>(nameof(default_account));
          _default_algo = user_backing<AlgoDefinitionVM>(nameof(default_algo));
+         _max_clip = backing<uint>(nameof(max_clip));
          // be sure to initialize backings before this measure_row_height call
          _row_height = backing(nameof(row_height), () => LadderRender.measure_row_height(get_result()));
          _orders.font_size_changed += on_font_size_changed;
@@ -166,7 +168,9 @@ namespace mbts.spark {
       public SimpleGridSettingsVM mini_ob { get; } = new SimpleGridSettingsVM(OrderBookGridSettingsManager.hard_column_flags);
       // price format
       public LadderSettings.NetChangeTerms price_format { get => _price_format; set => Set(ref _price_format, value); }
+      public LadderSettings.PriceDisplayFormat price_display_format { get => _price_display_format; set => Set(ref _price_display_format, value); }
       public IEnumerable<LadderSettings.NetChangeTerms> price_format_options => EnumHelper.get_values<LadderSettings.NetChangeTerms>();
+      public IEnumerable<LadderSettings.PriceDisplayFormat> price_display_format_options => EnumHelper.get_values<LadderSettings.PriceDisplayFormat>();
       // time in force
       public TimeInForce default_time_in_force { get => _default_time_in_force; set => Set(ref _default_time_in_force, value); }
       public IEnumerable<TimeInForce> time_in_force_options => EnumHelper.get_values_except(TimeInForce.Undefined);
@@ -182,6 +186,8 @@ namespace mbts.spark {
       public double zoom_factor { get => _zoom_factor; set => Set(ref _zoom_factor, value); }
       // safety checks
       public bool show_warn_on_cross { get => _show_warn_on_cross; set => Set(ref _show_warn_on_cross, value); }
+      public bool enforce_max_clip { get => _enforce_max_clip; set => Set(ref _enforce_max_clip, value); }
+      public uint max_clip { get => _max_clip.Value; set => _max_clip.Value = value; }
 
       // favorites
       public FavoriteAlgosVM favorite_algos_vm { get; }
@@ -354,8 +360,11 @@ namespace mbts.spark {
             _cancel_sells_visibility.show = settings.cancel_sells_visible;
             _cancel_all_visibility.show = settings.cancel_all_visible;
             price_format = settings.net_change;
+            price_display_format = settings.price_display_format;
             // safety checks
             show_warn_on_cross = settings.show_warn_on_cross;
+            enforce_max_clip = settings.enforce_max_clip;
+            max_clip = settings.max_clip;
          }
       }
 
@@ -428,8 +437,11 @@ namespace mbts.spark {
          clone.cancel_all_visible = _cancel_all_visibility.show;
          clone.zoom_slider_visible = _zoom_slider_visbility.show;
          clone.net_change = price_format;
+         clone.price_display_format = price_display_format;
          // safety checks
          clone.show_warn_on_cross = show_warn_on_cross;
+         clone.enforce_max_clip = enforce_max_clip;
+         clone.max_clip = max_clip;
          return clone;
       }
 

src/client/spark/Modules/Trading/Ladder/VM/LadderVM.cs

@@ -397,6 +397,8 @@ namespace mbts.spark {
       public uint volume_column_width { get => _volume_column_width.Value; set => _volume_column_width.set(value); }
       public uint alternate_order_size_from_settings => current_settings.alternate_order_size;
       public bool show_warn_on_cross_from_settings => current_settings.show_warn_on_cross;
+      public bool enforce_max_clip_from_settings => current_settings.enforce_max_clip;
+      public uint max_clip_from_settings => current_settings.max_clip;
       internal LadderModel model => _model;
       internal IObservable<LadderSettings> settings { get; }
 
@@ -447,6 +449,9 @@ namespace mbts.spark {
       public void key_down(KeyEventArgs e) {
          if (order_properties_vm == null)
             return;
+         if (KeyboardExtensions.IsDown(Key.Space)) {
+            _bus?.post(SparkTags.RequestRecenterLadder, null);
+         }
          // the ctrl modifier requirement helps avoid keyboard-input collisions w/ algo-templates popup
          if (!KeyboardExtensions.IsCtrlDown()) return;
          var new_algo = order_properties_vm.algo_definitions.FirstOrDefault(o => o.algo_root.key_match(e));
@@ -462,6 +467,10 @@ namespace mbts.spark {
          settings_invalidated?.Invoke();
       }
 
+      public void recenter_all_ladders() {
+         _bus?.post(SparkTags.RequestRecenterLadder, null);
+      }
+
       public Task send_order_async((double price, Side? side, MouseButton button) args) {
          if (order_properties_vm != null && args.button != MouseButton.Middle) {
             var size_from_alternate = args.button == MouseButton.Right;
@@ -470,6 +479,10 @@ namespace mbts.spark {
                   size_calculator.flash_error();
                } else {
                   uint size = size_from_alternate ? current_settings.alternate_order_size : (uint)Math.Abs(size_calculator.value ?? 0);
+                  // enforce max clip
+                  if (enforce_max_clip_from_settings && size > max_clip_from_settings) {
+                     size = max_clip_from_settings;
+                  }
                   return send_order_async(args.side.Value, size, args.price);
                }
             }

src/client/spark/Modules/Trading/Ladder/View/LadderGridHost.cs

@@ -350,6 +350,17 @@ namespace mbts.spark {
             }
          } else if (_vm != null) {
             uint size = e.ChangedButton == MouseButton.Right ? _vm.alternate_order_size_from_settings : _vm.size_calculator.value ?? 0;
+            
+            // does the size violate the local max clip
+            if (_vm.enforce_max_clip_from_settings && size > _vm.max_clip_from_settings) {
+               // note this size is only used for the cross market message, not the actual order command
+               size = _vm.max_clip_from_settings;
+               // only update the calculator value when it's a standard left-click order
+               if (e.ChangedButton == MouseButton.Left) {
+                  _vm.size_calculator.value = _vm.max_clip_from_settings;
+               }
+            }
+
             // if warning enabled && (buy above opposite inside market || ask below opposite inside market)
             // when 1-sided market, _get_top_price will return NaN, and so the price comparison is false
             // meaning show no warning == correct
@@ -479,8 +490,14 @@ namespace mbts.spark {
 
       protected override void OnMouseDoubleClick(MouseButtonEventArgs e) {
          var column = _column_for_point(e.GetPosition(this));
-         if (column.column_type == ColumnType.Price)
-            _scroll_to_center();
+         if (column.column_type == ColumnType.Price) {
+            if (Keyboard.IsKeyDown(Key.LeftShift) || Keyboard.IsKeyDown(Key.RightShift) ||
+               Keyboard.IsKeyDown(Key.LeftAlt) || Keyboard.IsKeyDown(Key.RightAlt)) {
+               _vm?.recenter_all_ladders();
+            } else {
+               _scroll_to_center();
+            }
+         }
       }
 
       #region Row Utility Methods
@@ -588,7 +605,8 @@ namespace mbts.spark {
                         _settings.row_height,
                         _price_list,
                         column.settings,
-                        security.ContractSpec);
+                        security.ContractSpec,
+                        _settings.price_display_format);
                   }
                   break;
                case ColumnType.Ask: render_market_col(_asks); break;
@@ -911,7 +929,7 @@ namespace mbts.spark {
          var prev_price_list = _price_list;
          _price_list = (!(_settings.net_change == LadderSettings.NetChangeTerms.None)) ?
             LadderRender.render_prices(_price_vis_tup.visual, _price_vis_tup.glyph_context, _mkt_break_lines.origin, _vm.md.settlement_price, _settings.net_change == LadderSettings.NetChangeTerms.Ticks, _row_count, _settings.row_height, _settings.price_column, security.ContractSpec) :
-            LadderRender.render_prices(_price_vis_tup.visual, _price_vis_tup.glyph_context, _mkt_break_lines.origin, _row_count, _settings.row_height, _settings.price_column, security.ContractSpec);
+            LadderRender.render_prices(_price_vis_tup.visual, _price_vis_tup.glyph_context, _mkt_break_lines.origin, _row_count, _settings.row_height, _settings.price_column, security.ContractSpec, _settings.price_display_format);
          _ordershost.update_settings(_price_list, _price_comparer, _settings.row_height, _settings.orders_column);
          if (prev_price_list != null) {
             // maintain previous visible price range if possible

src/client/spark/Modules/Trading/Ladder/View/LadderRender.cs

@@ -40,6 +40,8 @@ namespace mbts.spark {
       // Note: the orders-column has a separate "row_padding" value: Badge.DefaultMargin
       // (see how it is incorporated in measure_row_height() below)
       public static readonly Thickness row_padding = new Thickness(6);
+      const string tick_separator_period = ".";
+      const string tick_separator_dash = "-";
 
       // IMPORTANT: this method ONLY WORKS if Badges use the BadgeRender.margin/border_thickness/padding values.
       // TODO: elminate the dependency on BadgeRender.margin/border_thickness/padding by integrating them into settings.
@@ -52,8 +54,11 @@ namespace mbts.spark {
       public static int index_of(double[] prices, double price, IComparer<double> comparer) =>
          Array.BinarySearch(prices, price, comparer);
 
-      public static GlyphRun format_text(string text, int row, double row_height, LadderColumnSettings settings, GlyphContext glyph_context) =>
-         glyph_context.get_glyph_run(text, settings.font_size, settings.width, row_height, HorizontalAlignment.Center, 0, VerticalAlignment.Center, row * row_height, true);
+      public static GlyphRun format_text(string text, int row, double row_height, LadderColumnSettings settings, GlyphContext glyph_context, LadderSettings.PriceDisplayFormat price_display_format = LadderSettings.PriceDisplayFormat.Default) =>
+         glyph_context.get_glyph_run(
+            // long term there is probably a better way to get rid of the separator, such as in the TickExtensions._format_tick
+            price_display_format == LadderSettings.PriceDisplayFormat.Integer ? text.Replace(tick_separator_period, string.Empty).Replace(tick_separator_dash, string.Empty) : text, 
+            settings.font_size, settings.width, row_height, HorizontalAlignment.Center, 0, VerticalAlignment.Center, row * row_height, true);
 
       public static double[] gen_prices(double mid, int row_count, ContractSpecificationImmutable spec) {
          // require odd number
@@ -79,10 +84,10 @@ namespace mbts.spark {
             result[i] = format_text(spec.format(prices[i], reference_price, format_in_tick_terms), i, row_height, settings, glyph_context));
          return result;
       }
-      public static GlyphRun[] format_prices(double[] prices, double row_height, LadderColumnSettings settings, GlyphContext glyph_context, ContractSpecificationImmutable spec) {
+      public static GlyphRun[] format_prices(double[] prices, double row_height, LadderColumnSettings settings, GlyphContext glyph_context, ContractSpecificationImmutable spec, LadderSettings.PriceDisplayFormat price_display_format) {
          var result = new GlyphRun[prices.Length];
          Parallel.For(0, prices.Length, i =>
-            result[i] = format_text(spec.format(prices[i]), i, row_height, settings, glyph_context));
+            result[i] = format_text(spec.format(prices[i]), i, row_height, settings, glyph_context, price_display_format));
          return result;
       }
 
@@ -104,9 +109,9 @@ namespace mbts.spark {
       }
 
       public static double[] render_prices(DrawingVisual price, GlyphContext glyph_context, double mid, int row_count, double row_height,
-         LadderColumnSettings settings, ContractSpecificationImmutable spec) {
+         LadderColumnSettings settings, ContractSpecificationImmutable spec, LadderSettings.PriceDisplayFormat price_display_format) {
          var dprices = gen_prices(mid, row_count, spec);
-         render_prices(price, glyph_context, row_count, row_height, dprices, settings, spec);
+         render_prices(price, glyph_context, row_count, row_height, dprices, settings, spec, price_display_format);
          return dprices;
       }
 
@@ -122,10 +127,10 @@ namespace mbts.spark {
          }
       }
 
-      public static void render_prices(DrawingVisual price, GlyphContext glyph_context, int row_count, double row_height, double[] dprices, LadderColumnSettings settings, ContractSpecificationImmutable spec) {
+      public static void render_prices(DrawingVisual price, GlyphContext glyph_context, int row_count, double row_height, double[] dprices, LadderColumnSettings settings, ContractSpecificationImmutable spec, LadderSettings.PriceDisplayFormat price_display_format) {
          var foreground = settings.foreground.rgb_brush();
          //var background = new SolidColorBrush(settings.background.rgb_color());
-         var fprices = format_prices(dprices, row_height, settings, glyph_context, spec);
+         var fprices = format_prices(dprices, row_height, settings, glyph_context, spec, price_display_format);
          using (var dc = price.RenderOpen())
          using (_draw_with_clip(dc, settings, row_height, row_count)) {
             //dc.DrawRectangle(background, null, new Rect(0, 0, settings.width, row_count * row_height));

src/client/spark/Modules/Trading/Ladder/View/LadderSettingsView.xaml

@@ -178,6 +178,14 @@
       <Setter Property="VerticalAlignment" Value="Bottom"/>
     </Style>
 
+    <Style x:Key="EnableDisableFeatureText" TargetType="TextBlock">
+      <Style.Triggers>
+        <Trigger Property="IsEnabled" Value="False">
+          <Setter Property="Foreground" Value="{StaticResource {x:Static SystemColors.GrayTextBrushKey}}"/>
+        </Trigger>
+      </Style.Triggers>
+    </Style>
+
     <u:KeyedTemplateSelector x:Key="LadderColumnTemplateSelector">
       <u:KeyedTemplateSelector.Default>
         <DataTemplate>
@@ -630,7 +638,11 @@
           <ColumnDefinition Width="{Binding Source={StaticResource HorizontalPush3}}"/>
           <ColumnDefinition Width="*"/>
         </Grid.ColumnDefinitions>
-        <GroupBox Header="Size Display" DataContext="{Binding size_display}" Padding="4"> 
+        <Grid.RowDefinitions>
+          <RowDefinition />
+          <RowDefinition />
+        </Grid.RowDefinitions>
+        <GroupBox Header="Size Display" DataContext="{Binding size_display}" Padding="4" Grid.Row="0" Grid.RowSpan="2"> 
           <Grid>
             <Grid.ColumnDefinitions>
               <ColumnDefinition Width="Auto"/>
@@ -710,6 +722,7 @@
         </GroupBox>
         <GroupBox
           Grid.Column="2"
+          Grid.Row="0"
           VerticalAlignment="Top"
           Header="Price Display"
           Visibility="{Binding is_synthetic, Converter={StaticResource NetChangeGroupBoxIsVisibleVisibilityConverter}}"
@@ -717,6 +730,15 @@
         >
           <c:RadioButtonsControl ItemsSource="{Binding price_format_options}" ItemTemplate="{StaticResource EnumDescriptionTemplate}" SelectedItem="{Binding price_format}"/>
         </GroupBox>
+        <GroupBox
+          Grid.Row="1"
+          Grid.Column="2"
+          VerticalAlignment="Stretch"
+          Header="Price Display Format"
+          Padding="4"
+        >
+          <c:RadioButtonsControl ItemsSource="{Binding price_display_format_options}" ItemTemplate="{StaticResource EnumDescriptionTemplate}" SelectedItem="{Binding price_display_format}"/>
+        </GroupBox>
       </Grid>
     </TabItem>
     <!-- Size Presets Tab-->
@@ -991,21 +1013,45 @@
       <Grid HorizontalAlignment="Left" Margin="6">
         <Grid.RowDefinitions>
           <RowDefinition Height="Auto"/>
+          <RowDefinition Height="Auto" />
           <RowDefinition Height="{Binding Source={StaticResource VerticalPush1}}"/>
           <RowDefinition Height="Auto"/>
         </Grid.RowDefinitions>
         <Grid.ColumnDefinitions>
           <ColumnDefinition Width="Auto"/>
+          <ColumnDefinition Width="Auto"/>
+          <ColumnDefinition Width="50"/>
           <ColumnDefinition Width="{Binding Source={StaticResource HorizontalPush3}}"/>
           <ColumnDefinition Width="*"/>
         </Grid.ColumnDefinitions>
-        <CheckBox Content="Warn on Market Cross" FlowDirection="RightToLeft" IsChecked="{Binding show_warn_on_cross}">
+        <!-- market cross -->
+        <CheckBox Name="warn" Grid.Column="0" FlowDirection="RightToLeft" IsChecked="{Binding show_warn_on_cross}">
           <CheckBox.Resources>
             <Style TargetType="{x:Type Path}">
               <Setter Property="FlowDirection" Value="LeftToRight"/>
             </Style>
           </CheckBox.Resources>
         </CheckBox>
+        <TextBlock Grid.Column="1"
+                   Style="{StaticResource EnableDisableFeatureText}"
+                   IsEnabled="{Binding ElementName=warn, Path=IsChecked}"
+                   Text="Warn on Market Cross" />
+        <!-- max order qty -->
+        <CheckBox Name="enforce_max_clip" Grid.Row="1" Grid.Column="0" FlowDirection="RightToLeft" IsChecked="{Binding enforce_max_clip}">
+          <CheckBox.Resources>
+            <Style TargetType="{x:Type Path}">
+              <Setter Property="FlowDirection" Value="LeftToRight"/>
+            </Style>
+          </CheckBox.Resources>
+        </CheckBox>
+        <TextBlock Grid.Row="1" Grid.Column="1"
+                   Style="{StaticResource EnableDisableFeatureText}"
+                   IsEnabled="{Binding ElementName=enforce_max_clip, Path=IsChecked}"
+                   MinWidth="{Binding ElementName=warn, Path=ActualWidth}"
+                   Text="Max Order Quantity"/>
+        <c:TickUpDownUInt Grid.Row="1" Grid.Column="2"
+                          IsEnabled="{Binding ElementName=enforce_max_clip, Path=IsChecked}"
+                          Value="{Binding max_clip}" />
       </Grid>
     </TabItem>
     <TabItem Header="Mini Order Book">

src/client/spark/Modules/Trading/PNL/Settings/VM/PNLSettingsVM.cs

@@ -1,220 +1,223 @@
-using bts.collections;
-using bts.utils;
-using mbts;
-using mbts.collections;
-using mbts.expression;
-using mbts.spark;
-using mbts.ui;
-using mbts.ui.settings;
-using mbts.ui.shell;
-using mbts.ui.spark;
-using mbts.ui.utility;
-using mbts.utils;
-using System;
-using System.Collections.Generic;
-using System.Collections.ObjectModel;
-using System.Collections.Specialized;
-using System.Dynamic;
-using System.Linq;
-using ColumnKeys = bts.shell.pnl.PNLView.Columns;
-
-namespace bts.shell.pnl {
-   class PNLSettingsVM : DisposableViewModelBase, IWindowSettingsVM<PNLSettings>, IValueFactory<PNLSettings>, IObservable<PNLSettings>, ITemplateSelectorKey {
-      readonly IReadOnlyDictionary<ColumnKeys, AnchorItemVM> _anchor_cache;
-      readonly DeferrableActionWrapper _sync_anchors;
-
-      PNLCalculationType _calculation_type;
-      PNLHeaderRowDisplay _header_row_display;
-      PNLSettings _last_loaded;
-
-      public PNLSettingsVM(PNLSettings settings) {
-         // init anchor cache, deferrable resync
-         _anchor_cache = PNLSettings.anchorable_columns.ToDictionary(k => k, k => new AnchorItemVM(this, k));
-         _sync_anchors = new DeferrableActionWrapper(() => {
-            for (int i = 0; i < anchor_items.Count; i++) {
-               anchor_items[i].anchor_index = i + 1;
-               anchor_items[i].refresh();
-            }
-         });
-         core_settings_vm = new SimpleGridSettingsVM(column_factory: col_settings => {
-            var col_vm = new PNLColumnVM(core_settings_vm, EnumHelper.parse<ColumnKeys>(col_settings.id));
-            col_vm.load_from(col_settings);
-            return col_vm;
-         });
-         core_settings_vm.selection_highlight.bind_opacity_to_alpha = true;
-         _dispose = Disposable.Create(
-            anchor_items.Subscribe((s, e) => _sync_anchors.execute()));
-         load(settings);
-      }
-
-      public IEnumerable<AnchorItemVM> anchor_item_headers => _anchor_cache.Values;
-      public ObservableCollection<AnchorItemVM> anchor_items { get; } = new ObservableCollection<AnchorItemVM>();
-      public SimpleGridSettingsVM core_settings_vm { get; }
-      public PNLGroupRowAppearanceVM group_row_defaults { get; } = new PNLGroupRowAppearanceVM();
-      public PNLCellAppearanceVM header_row_defaults { get; } = new PNLCellAppearanceVM();
-      public PNLCalculationType calculation_type { get => _calculation_type; set => Set(ref _calculation_type, value); }
-      public IEnumerable<PNLCalculationType> calculation_types => EnumHelper.get_values_except(PNLCalculationType.None, PNLCalculationType.Same, PNLCalculationType.Opposite);
-      public PNLHeaderRowDisplay header_row_display { get => _header_row_display; set => Set(ref _header_row_display, value); }
-      public IEnumerable<PNLHeaderRowDisplay> header_row_display_options => PNLSettings.header_row_display_options;
-
-      string ITemplateSelectorKey.key => GridSettingsTemplateKeys.PNL;
-
-      public PNLSettings get_result() {
-         var s = _last_loaded == null ? new PNLSettings() : SparkUtils.clone_proto(_last_loaded);
-         s.calculation_type = _calculation_type;
-         s.grid = core_settings_vm.create();
-         // move anchor cols to the left, order wrt grouping hierarchy
-         var new_cols = new Lazy<List<GridColumnSettings>>(() => s.grid.columns.ToList());
-         for (int i = 0; i < s.grid.columns.Count; i++) {
-            var key = s.grid.columns[i].strong_id<ColumnKeys>();
-            if (_anchor_cache.TryGetValue(key, out var a) && a.anchor_index.HasValue) {
-               // anchor index is 1 based, subtract 1 to get 0 based
-               int anchor_index = a.anchor_index.Value - 1;
-               if (anchor_index != i && anchor_index >= 0 && anchor_index < s.grid.columns.Count) {
-                  new_cols.Value.RemoveAt(i);
-                  new_cols.Value.Insert(anchor_index, s.grid.columns[i]);
-               }
+using bts.collections;
+using bts.utils;
+using mbts;
+using mbts.collections;
+using mbts.expression;
+using mbts.spark;
+using mbts.ui;
+using mbts.ui.settings;
+using mbts.ui.shell;
+using mbts.ui.spark;
+using mbts.ui.utility;
+using mbts.utils;
+using System;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using System.Collections.Specialized;
+using System.Dynamic;
+using System.Linq;
+using ColumnKeys = bts.shell.pnl.PNLView.Columns;
+
+namespace bts.shell.pnl {
+   class PNLSettingsVM : DisposableViewModelBase, IWindowSettingsVM<PNLSettings>, IValueFactory<PNLSettings>, IObservable<PNLSettings>, ITemplateSelectorKey {
+      readonly IReadOnlyDictionary<ColumnKeys, AnchorItemVM> _anchor_cache;
+      readonly DeferrableActionWrapper _sync_anchors;
+
+      PNLCalculationType _calculation_type;
+      PNLHeaderRowDisplay _header_row_display;
+      PNLSettings _last_loaded;
+
+      public PNLSettingsVM(PNLSettings settings) {
+         // init anchor cache, deferrable resync
+         _anchor_cache = PNLSettings.anchorable_columns.ToDictionary(k => k, k => new AnchorItemVM(this, k));
+         _sync_anchors = new DeferrableActionWrapper(() => {
+            for (int i = 0; i < anchor_items.Count; i++) {
+               anchor_items[i].anchor_index = i + 1;
+               anchor_items[i].refresh();
             }
-         }
-         // rule-based animations
-         var trigger_anims = core_settings_vm.columns
-            .OfType<PNLColumnVM>()
-            .SelectMany(c => c.get_triggers())
-            .GroupBy(tup => tup.expression)
-            .Where(g => CoreExpressionEvaluator<PNLRowData>.validate(g.Key))
-            .Select(g => (
-               expression: g.Key,
-               animations: g.ToArray()))
-            .ToList();
-
-         var normalized_anims = trigger_anims
-            .Where(tup => CoreExpressionEvaluator<PNLNormalizedData>.validate(tup.expression))
-            .ToList();
-
-         s = s.with(anchors: anchor_items.Select(vm => vm.key),
-            grid: new_cols.IsValueCreated ? s.grid.with(columns: new_cols.Value) : null,
-            group_columns: core_settings_vm.columns.OfType<PNLColumnVM>().Select(c => {
-               var col_settings = c.create();
-               col_settings = c.group_column_vm.apply_to(col_settings);
-               return col_settings;
-            }),
-            header_columns: core_settings_vm.columns.OfType<PNLColumnVM>().Select(c => {
-               var col_settings = c.create();
-               col_settings = c.header_column_vm.apply_to(col_settings);
-               return col_settings;
-            }),
-            animations: trigger_anims.Select(
-               ta => new PNLAnimationTriggerData {
-                  expression = ta.expression,
-                  animations = Array.ConvertAll(ta.animations, t => t.row)
-               }),
-            group_header_animations: normalized_anims
-            .Select(
-               ta => new PNLAnimationTriggerData {
-                  expression = ta.expression,
-                  animations = Array.ConvertAll(ta.animations, t => t.group)
-               }),
-            header_row_animations: normalized_anims.Select(
-               ta => new PNLAnimationTriggerData {
-                  expression = ta.expression,
-                  animations = Array.ConvertAll(ta.animations, t => t.header)
-               }));
-         s.header_row_display = header_row_display;
-         s.header_cell_appearance = PNLCellAppearanceProto.from_appearance(header_row_defaults.to_appearance());
-         // group
-         var (group_cell_appearance, group_row_background_colors) = group_row_defaults.create();
-         s.group_cell_appearance = PNLCellAppearanceProto.from_appearance(group_cell_appearance);
-         s.group_background_colors.SetItems(group_row_background_colors.Select(c => c.rgb_color()));
-         //
-         return s;
-      }
-
-      public void load(PNLSettings value) {
-         _last_loaded = value;
-         header_row_defaults.load(value.header_cell_appearance.to_appearance());
-         group_row_defaults.load_from((value.group_cell_appearance.to_appearance(), value.group_background_colors.WrapSelectorRO(c => c.argb_color())));
-         var column_map = _map_column_data(value.grid.columns, value.animations);
-         var group_column_map = _map_column_data(value.group_columns, value.group_header_animations);
-         var header_column_map = _map_column_data(value.header_columns, value.header_row_animations);
-
-         core_settings_vm.load_from(value.grid);
-
-         for (int i = 0; i < core_settings_vm.columns.Count; i++) {
-            var col_vm = core_settings_vm.columns[i] as PNLColumnVM ?? throw new InvalidOperationException($"In {nameof(PNLSettingsVM)}, all columns should be of type {typeof(PNLColumnVM)}.");
-            var key = EnumHelper.parse<ColumnKeys>(col_vm.id);
-            var (col_settings, trigger_animations) = column_map[key];
-            var group_data = group_column_map.GetNullable(key);
-            var header_data = header_column_map.GetNullable(key);
-            col_vm.load_from(col_settings, trigger_animations, group_data?.settings, group_data?.triggers, header_data?.triggers, header_data?.settings);
-         }
-         using (_sync_anchors.defer_execution())
-            anchor_items.WrapSelector(a => a.key, k => _anchor_cache[k]).sync_with(value.anchors.Intersect(PNLSettings.anchorable_columns));
-         header_row_display = value.header_row_display;
-         calculation_type = value.calculation_type;
-       }
-
-      PNLSettings IValueFactory<PNLSettings>.create() => get_result();
-      void IValueFactory<PNLSettings>.load_from(PNLSettings value) => load(value);
-      IDisposable IObservable<PNLSettings>.Subscribe(IObserver<PNLSettings> observer) => throw new NotImplementedException();
-
-      static Dictionary<ColumnKeys, (GridColumnSettings settings, Dictionary<string, PNLAnimation> triggers)> _map_column_data(IEnumerable<GridColumnSettings> columns, IEnumerable<PNLAnimationTriggerData> triggers) {
-         var map = columns.ToDictionary(
-            c => c.strong_id<ColumnKeys>(),
-            c => (settings: c, triggers: new Dictionary<string, PNLAnimation>()));
-         foreach (var trig in triggers) {
-            foreach (var anim in trig.animations) {
-               if (map.TryGetValue(anim.column, out var col_data))
-                     col_data.triggers[trig.expression] = anim;
-            }
-         }
-         return map;
-      }
-
-      void _append_or_remove_anchor(ColumnKeys key, bool include) {
-         if (!_anchor_cache.TryGetValue(key, out var vm))
-            throw new KeyNotFoundException($"Column key '{key}' is not anchorable (expected one of: {string.Join(", ", PNLSettings.anchorable_columns)}).");
-         if (vm.include == include)
-            return;
-         if (include) {
-            if (anchor_items.Any(a => a.key == key))
-               throw new InvalidOperationException($"{nameof(anchor_items)} already contains an element with key '{key}.'");
-            anchor_items.Add(vm);
-            vm.anchor_index = anchor_items.Count;
-         } else {
-            if (!anchor_items.Remove(vm))
-               throw new InvalidOperationException($"{nameof(anchor_items)} does not contain an element with key '{key}.'");
-            vm.anchor_index = null;
-         }
-         _sync_anchors.execute();
-      }
-
-      public class AnchorItemVM : ViewModelBase, IEquatable<AnchorItemVM> {
-         readonly PNLSettingsVM _owner;
-         int? _anchor_index;
-
-         public AnchorItemVM(PNLSettingsVM owner, ColumnKeys key) {
-            _owner = owner;
-            this.key = key;
-         }
-
-         public ColumnKeys key { get; }
-         public bool include { get => anchor_index.HasValue; set => _owner._append_or_remove_anchor(key, value); }
-         public int? anchor_index { get => _anchor_index; set => Set(ref _anchor_index, value); }
-
-         public void refresh() =>
-            RaisePropertyChanged(nameof(include), nameof(anchor_index));
-
-         public bool Equals(AnchorItemVM other) =>
-            other != null && key == other.key;
-
-         public override bool Equals(object obj) =>
-            Equals(obj as AnchorItemVM);
-
-         public override int GetHashCode() =>
-            key.GetHashCode();
-
-         public override string ToString() =>
-            EnumHelper.get_display_name(key);
-      }
-   }
+         });
+         core_settings_vm = new SimpleGridSettingsVM(column_factory: col_settings => {
+            var col_vm = new PNLColumnVM(core_settings_vm, EnumHelper.parse<ColumnKeys>(col_settings.id));
+            col_vm.load_from(col_settings);
+            return col_vm;
+         });
+         core_settings_vm.selection_highlight.bind_opacity_to_alpha = true;
+         _dispose = Disposable.Create(
+            anchor_items.Subscribe((s, e) => _sync_anchors.execute()));
+         load(settings);
+      }
+
+      public IEnumerable<AnchorItemVM> anchor_item_headers => _anchor_cache.Values;
+      public ObservableCollection<AnchorItemVM> anchor_items { get; } = new ObservableCollection<AnchorItemVM>();
+      public SimpleGridSettingsVM core_settings_vm { get; }
+      public PNLGroupRowAppearanceVM group_row_defaults { get; } = new PNLGroupRowAppearanceVM();
+      public PNLCellAppearanceVM header_row_defaults { get; } = new PNLCellAppearanceVM();
+      public PNLCalculationType calculation_type { get => _calculation_type; set => Set(ref _calculation_type, value); }
+      public IEnumerable<PNLCalculationType> calculation_types => EnumHelper.get_values_except(PNLCalculationType.None, PNLCalculationType.Same, PNLCalculationType.Opposite);
+      public PNLHeaderRowDisplay header_row_display { get => _header_row_display; set => Set(ref _header_row_display, value); }
+      public IEnumerable<PNLHeaderRowDisplay> header_row_display_options => PNLSettings.header_row_display_options;
+
+      string ITemplateSelectorKey.key => GridSettingsTemplateKeys.PNL;
+
+      public PNLSettings get_result() {
+         var s = _last_loaded == null ? new PNLSettings() : SparkUtils.clone_proto(_last_loaded);
+         s.calculation_type = _calculation_type;
+         s.grid = core_settings_vm.create();
+         // move anchor cols to the left, order wrt grouping hierarchy
+         List<GridColumnSettings> new_cols = null;
+         IEnumerable<GridColumnSettings> cols = s.grid.columns;
+         var sorted_anchors = anchor_items.OrderBy(a => a.anchor_index).ToList();
+         for (int i = 0; i < sorted_anchors.Count; i++) {
+            if (GridSettingsHelper.try_find_column(cols, sorted_anchors[i].key, out var match, out int pos) && pos != i) {
+               if (new_cols == null) {
+                  new_cols = s.grid.columns.ToList();
+                  // set cols to new_cols so subsequent position lookups
+                  // take previous column order manipulations into account.
+                  cols = new_cols;
+               }
+               new_cols.RemoveAt(pos);
+               new_cols.Insert(i, match);
+            }
+         }
+         // rule-based animations
+         var trigger_anims = core_settings_vm.columns
+            .OfType<PNLColumnVM>()
+            .SelectMany(c => c.get_triggers())
+            .GroupBy(tup => tup.expression)
+            .Where(g => CoreExpressionEvaluator<PNLRowData>.validate(g.Key))
+            .Select(g => (
+               expression: g.Key,
+               animations: g.ToArray()))
+            .ToList();
+
+         var normalized_anims = trigger_anims
+            .Where(tup => CoreExpressionEvaluator<PNLNormalizedData>.validate(tup.expression))
+            .ToList();
+
+         s = s.with(anchors: anchor_items.Select(vm => vm.key),
+            grid: new_cols == null ? null : s.grid.with(columns: new_cols),
+            group_columns: core_settings_vm.columns.OfType<PNLColumnVM>().Select(c => {
+               var col_settings = c.create();
+               col_settings = c.group_column_vm.apply_to(col_settings);
+               return col_settings;
+            }),
+            header_columns: core_settings_vm.columns.OfType<PNLColumnVM>().Select(c => {
+               var col_settings = c.create();
+               col_settings = c.header_column_vm.apply_to(col_settings);
+               return col_settings;
+            }),
+            animations: trigger_anims.Select(
+               ta => new PNLAnimationTriggerData {
+                  expression = ta.expression,
+                  animations = Array.ConvertAll(ta.animations, t => t.row)
+               }),
+            group_header_animations: normalized_anims
+            .Select(
+               ta => new PNLAnimationTriggerData {
+                  expression = ta.expression,
+                  animations = Array.ConvertAll(ta.animations, t => t.group)
+               }),
+            header_row_animations: normalized_anims.Select(
+               ta => new PNLAnimationTriggerData {
+                  expression = ta.expression,
+                  animations = Array.ConvertAll(ta.animations, t => t.header)
+               }));
+         s.header_row_display = header_row_display;
+         s.header_cell_appearance = PNLCellAppearanceProto.from_appearance(header_row_defaults.to_appearance());
+         // group
+         var (group_cell_appearance, group_row_background_colors) = group_row_defaults.create();
+         s.group_cell_appearance = PNLCellAppearanceProto.from_appearance(group_cell_appearance);
+         s.group_background_colors.SetItems(group_row_background_colors.Select(c => c.rgb_color()));
+         //
+         return s;
+      }
+
+      public void load(PNLSettings value) {
+         _last_loaded = value;
+         header_row_defaults.load(value.header_cell_appearance.to_appearance());
+         group_row_defaults.load_from((value.group_cell_appearance.to_appearance(), value.group_background_colors.WrapSelectorRO(c => c.argb_color())));
+         var column_map = _map_column_data(value.grid.columns, value.animations);
+         var group_column_map = _map_column_data(value.group_columns, value.group_header_animations);
+         var header_column_map = _map_column_data(value.header_columns, value.header_row_animations);
+
+         core_settings_vm.load_from(value.grid);
+
+         for (int i = 0; i < core_settings_vm.columns.Count; i++) {
+            var col_vm = core_settings_vm.columns[i] as PNLColumnVM ?? throw new InvalidOperationException($"In {nameof(PNLSettingsVM)}, all columns should be of type {typeof(PNLColumnVM)}.");
+            var key = EnumHelper.parse<ColumnKeys>(col_vm.id);
+            var (col_settings, trigger_animations) = column_map[key];
+            var group_data = group_column_map.GetNullable(key);
+            var header_data = header_column_map.GetNullable(key);
+            col_vm.load_from(col_settings, trigger_animations, group_data?.settings, group_data?.triggers, header_data?.triggers, header_data?.settings);
+         }
+         using (_sync_anchors.defer_execution())
+            anchor_items.WrapSelector(a => a.key, k => _anchor_cache[k]).sync_with(value.anchors.Intersect(PNLSettings.anchorable_columns));
+         header_row_display = value.header_row_display;
+         calculation_type = value.calculation_type;
+       }
+
+      PNLSettings IValueFactory<PNLSettings>.create() => get_result();
+      void IValueFactory<PNLSettings>.load_from(PNLSettings value) => load(value);
+      IDisposable IObservable<PNLSettings>.Subscribe(IObserver<PNLSettings> observer) => throw new NotImplementedException();
+
+      static Dictionary<ColumnKeys, (GridColumnSettings settings, Dictionary<string, PNLAnimation> triggers)> _map_column_data(IEnumerable<GridColumnSettings> columns, IEnumerable<PNLAnimationTriggerData> triggers) {
+         var map = columns.ToDictionary(
+            c => c.strong_id<ColumnKeys>(),
+            c => (settings: c, triggers: new Dictionary<string, PNLAnimation>()));
+         foreach (var trig in triggers) {
+            foreach (var anim in trig.animations) {
+               if (map.TryGetValue(anim.column, out var col_data))
+                     col_data.triggers[trig.expression] = anim;
+            }
+         }
+         return map;
+      }
+
+      void _append_or_remove_anchor(ColumnKeys key, bool include) {
+         if (!_anchor_cache.TryGetValue(key, out var vm))
+            throw new KeyNotFoundException($"Column key '{key}' is not anchorable (expected one of: {string.Join(", ", PNLSettings.anchorable_columns)}).");
+         if (vm.include == include)
+            return;
+         if (include) {
+            if (anchor_items.Any(a => a.key == key))
+               throw new InvalidOperationException($"{nameof(anchor_items)} already contains an element with key '{key}.'");
+            anchor_items.Add(vm);
+            vm.anchor_index = anchor_items.Count;
+         } else {
+            if (!anchor_items.Remove(vm))
+               throw new InvalidOperationException($"{nameof(anchor_items)} does not contain an element with key '{key}.'");
+            vm.anchor_index = null;
+         }
+         _sync_anchors.execute();
+      }
+
+      public class AnchorItemVM : ViewModelBase, IEquatable<AnchorItemVM> {
+         readonly PNLSettingsVM _owner;
+         int? _anchor_index;
+
+         public AnchorItemVM(PNLSettingsVM owner, ColumnKeys key) {
+            _owner = owner;
+            this.key = key;
+         }
+
+         public ColumnKeys key { get; }
+         public bool include { get => anchor_index.HasValue; set => _owner._append_or_remove_anchor(key, value); }
+         public int? anchor_index { get => _anchor_index; set => Set(ref _anchor_index, value); }
+
+         public void refresh() =>
+            RaisePropertyChanged(nameof(include), nameof(anchor_index));
+
+         public bool Equals(AnchorItemVM other) =>
+            other != null && key == other.key;
+
+         public override bool Equals(object obj) =>
+            Equals(obj as AnchorItemVM);
+
+         public override int GetHashCode() =>
+            key.GetHashCode();
+
+         public override string ToString() =>
+            EnumHelper.get_display_name(key);
+      }
+   }
 }

src/client/spark/Modules/Trading/PNL/VM/PNLRowComparer.cs

@@ -90,12 +90,11 @@ namespace bts.shell.pnl {
       }
 
       int? _try_compare_groups(CollectionViewGroup x, CollectionViewGroup y) {
-         if (x == null || y == null)
-            return null;
-         var xcell = (IPNLCellData)x.Name;
-         var ycell = (IPNLCellData)y.Name;
-         var comp = _get_column_comparer(xcell.column);
-         return comp.value_comparer.Compare(xcell.value, ycell.value);
+         if (x?.Name is IPNLCellData xcell && y?.Name is IPNLCellData ycell) {
+            var comp = _get_column_comparer(xcell.column);
+            return comp.value_comparer.Compare(xcell.value, ycell.value);
+         }
+         return null;
       }
    }
-}
+}

src/client/spark/Modules/Trading/PNL/View/PNLView.xaml

@@ -698,8 +698,8 @@
               c:DataGridFilterProperties.FilterActive="{Binding DataContext.security_filter.active, Source={u:DirectReference _grid}}"
               c:DataGridFilterProperties.FilterOpen="{Binding DataContext.security_filter.open, Source={u:DirectReference _grid}}"
               key="Security"
-              sort_member_path="security_cell.cell_data"
-              data_member_path="security"
+              data_member_path="security_cell.cell_data"
+              sort_member_path="security"
               HeaderTemplate="{StaticResource AnchorableColumnHeaderTemplate}"
             />
             <!--Security Key-->

src/client/spark/core/Utility/MiscUtils.cs

@@ -102,14 +102,14 @@ namespace mbts.utils
                string identifier = ((felem.Name != null) && (felem.Name.Length > 0)) ?
                    felem.Name :
                    felem.GetType().ToString();
-               return "$FrameworkElement [{identifier}]";
+               return $"FrameworkElement [{identifier}]";
             } else {
                // Maybe a FrameworkContentElement has focus
                if (elem is FrameworkContentElement fcelem) {
                   string identifier = ((fcelem.Name != null) && (fcelem.Name.Length > 0)) ?
                       fcelem.Name :
                       fcelem.GetType().ToString();
-                  return "$FrameworkContentElement [{identifier}]";
+                  return $"FrameworkContentElement [{identifier}]";
                }
                return $"Element of type [{elem.GetType().ToString()}] has focus";
             }

src/client/spark_api/utils/Log.cs

@@ -34,7 +34,7 @@ namespace bts {
       Latency,
       DataFlow,
       Plugin,
-      ClientSdk,
+      Sdk,
       Http,
       // Please keep this list in sync with logging.h/logging.cpp
    }
@@ -103,7 +103,7 @@ namespace bts {
       internal static Logger Ui => new Logger(Subsystem.Ui);
       internal static Logger Testing => new Logger(Subsystem.Testing);
       internal static Logger DataFlow => new Logger(Subsystem.DataFlow);
-      public static Logger ClientSdk => new Logger(Subsystem.ClientSdk);
+      public static Logger Sdk => new Logger(Subsystem.Sdk);
       public static Logger Http => new Logger(Subsystem.Http);
 
       internal static void log_at(this Logger logger, Level level, string message) {

src/client/spark_core/utils/FileUtils.cs

@@ -61,15 +61,17 @@ namespace bts.support {
 
       // Delete the oldest files matching pattern (*.txt) keeping {count} files
       public static void keep_n_matching_files(string directory, string pattern, int count) {
-         var to_delete =
-            Directory.GetFiles(directory, pattern)
-            .Select(f => new { name = f, modified = File.GetLastWriteTimeUtc(f) })
-            .OrderBy(f => f.modified)
-            .Reverse()
-            .Skip(count);
+         if (Directory.Exists(directory)) {
+            var to_delete =
+               Directory.GetFiles(directory, pattern)
+               .Select(f => new { name = f, modified = File.GetLastWriteTimeUtc(f) })
+               .OrderBy(f => f.modified)
+               .Reverse()
+               .Skip(count);
 
-         foreach (var f in to_delete) {
-            try_delete(f.name);
+            foreach (var f in to_delete) {
+               try_delete(f.name);
+            }
          }
       }
    }

src/client/spark_sdk/samples/SDKMain.cs

@@ -23,7 +23,7 @@ namespace bts.sdk
       public static void Main(string[] args)
       {         
          BTS.init();
-         Log.ClientSdk.info("Welcome to the BTS Client Side SDK example");
+         Log.Sdk.info("Welcome to the BTS Client Side SDK example");
          var ctx = new ServiceContext();
 
          string u = args.FirstOrDefault(x => x.Contains("--user="));

src/client/spark_sdk/spark_sdk.csproj

@@ -71,10 +71,6 @@
     </ItemGroup>
   </Target>
 
-   <Target Name="copy_scripts" AfterTargets="PostBuildEvent" Condition= " '$(SparkRoot)' != '' " >
-     <Copy SourceFiles="../../sdk/update_github.cmd" DestinationFolder="$(OutputPath)\" SkipUnchangedFiles="true" />
-   </Target>
-
   <!-- deployed sdk build net471 -->
   <ItemGroup Condition= " '$(SparkRoot)' == '' and '$(TargetFramework)' == 'net471'">
     <Reference Include="spark_api">

src/lib/CMakeDeps_win.cmake

@@ -1 +1 @@
-set(sources api/apicore.proto;api/apigateway.proto;api/apioptions.proto;api/core/ApiClientInterop.cpp;api/core/ApiServerInterop.cpp;api/public/ApiServer.cpp;api/public/ClientChannel.cpp;api/public/QuickbusClientChannel.cpp;api/public/ServerChannel.cpp;api/public/ServiceContext.cpp;api/service_helpers/AdminServiceUtils.cpp;api/service_helpers/AlgoServiceUtils.cpp;api/service_helpers/PositionUtilities.cpp;api/services/AdminService.proto;api/services/AlgoDefinitionService.proto;api/services/AlgoService.proto;api/services/ApiUnitTestService.proto;api/services/AuthService.proto;api/services/BasePositionService.proto;api/services/ErrorReportService.proto;api/services/HelloService.proto;api/services/MBOService.proto;api/services/MarginService.proto;api/services/MarketDataAuxiliaryService.proto;api/services/MarketDataRelay.proto;api/services/MoneyFileService.proto;api/services/OrderService.proto;api/services/OutOfProcessURLListener.proto;api/services/PersistenceService.proto;api/services/PositionService.proto;api/services/ShellDiagnosticService.proto;api/services/ShellLatencyService.proto;api/services/SyntheticSecurityService.proto;api/test/ApiTests.cpp;api/test/HelloServiceServer.cpp;config/ConfigCheck.cpp;config/ConfigDownloader.cpp;config/ConfigErrorCollector.cpp;config/ConfigLog.cpp;config/ConfigPropertyEvaluator.cpp;config/ConfigValueQueue.cpp;config/ConfigurationException.cpp;config/ConfigurationState.cpp;config/PreprocessInputStream.cpp;config/config.cpp;config/defaults/MarketData.conf;config/defaults/Ports.conf;config/defaults/Symbols.conf;config/defaults/cme_reference_data.conf;config/defaults/edge.conf;config/defaults/jetfix.conf;config/defaults/keycode.conf;config/defaults/logging.conf;config/defaults/orderman_cfg.conf;config/defaults/orders_fills_cleanup.conf;config/defaults/position_cfg.conf;config/defaults/span.conf;config/defaults/spreader.conf;config/defaults/testkeys.conf;config/defaults/threads.conf;config/defaults/toggles.conf;config/extensions/extensions.proto;config/invalid/invalid.proto;config/protos/ExchangeSimCfg.proto;config/protos/MarketData.proto;config/protos/Ports.proto;config/protos/Symbols.proto;config/protos/UI.proto;config/protos/cme_reference_data.proto;config/protos/jetfix.proto;config/protos/keycode.proto;config/protos/logging.proto;config/protos/mercury_cfg.proto;config/protos/orderman_cfg.proto;config/protos/orders_fills_cleanup.proto;config/protos/perflog_cfg.proto;config/protos/position_cfg.proto;config/protos/quickbus_cfg.proto;config/protos/span.proto;config/protos/spreader.proto;config/protos/system.proto;config/protos/testkeys.proto;config/protos/threads.proto;config/protos/toggles.proto;config/tests/HTTPServer.cpp;config/tests/config_ref_tests.cpp;config/tests/config_tests.cpp;config/text_format/text_format.cpp;domain_model/Security.cpp;domain_model/Security.proto;domain_model/SecurityTests.cpp;domain_model/sod.cpp;domain_model/tests/domain_tests.cpp;expression/BooleanGrammar.cpp;expression/ExpressionEvaluator.cpp;expression/ParserExceptions.cpp;expression/Value.cpp;expression/tests/expression_parser_tests.cpp;logging/LoggerHub.cpp;logging/Sink.cpp;logging/logging.cpp;logging/tests/logging_tests.cpp;md/Diag/MDPeriodicDumper.cpp;md/Diag/ShmDumper.cpp;md/MBOProcessor.cpp;md/MBOServiceServer.cpp;md/MDClient.cpp;md/MDConsumer.cpp;md/MDConsumerHandle.cpp;md/MDConsumerInterop.cpp;md/MDProducer.cpp;md/MDProducerHandle.cpp;md/MemorySegmentUtils.cpp;md/PlatformLoader.cpp;md/PriceSize.cpp;md/SecurityCache.cpp;md/SecurityDB.cpp;md/SecurityIDRecorder.cpp;md/SecurityMapper.cpp;md/SecurityOracle.cpp;md/SettlementRecorder.cpp;md/Shm/FixedSecurity.cpp;md/SyntheticSecurityService.cpp;md/cme/MDP3Utils.cpp;md/common.cpp;md/ice/ICEUtils.cpp;md/protos/co2.proto;md/relay/QueryServer.cpp;md/relay/RelayClient.cpp;md/relay/RelayRecorder.cpp;md/test/Co2ManagedTestHelper.cpp;md/test/Co2TestInstrument.cpp;md/test/mbo_tests.cpp;md/test/md2_tests.cpp;md/test/md_test_utils.cpp;md/test/synthetic_book_merge_tests.cpp;md/vendor/OnixsUtils.cpp;os/os.cpp;os/tests/os_tests.cpp;quickbus/core/LocalNode.cpp;quickbus/core/Quickbus.cpp;quickbus/core/SubscriptionID.cpp;quickbus/core/TableID.cpp;quickbus/message_model/Update.cpp;quickbus/message_model/merge_updates.cpp;quickbus/network/QBConnection.cpp;quickbus/network/QBConnectionManager.cpp;quickbus/network/endpoint_description.cpp;quickbus/network/quickbus_msgs.proto;quickbus/pubsub/TablePublisher.cpp;quickbus/pubsub/TableSubscriber.cpp;quickbus/pubsub/tests/qb_pubsub_tests.cpp;quickbus/routing/INode.cpp;quickbus/routing/NodeID.cpp;quickbus/routing/Router.cpp;quickbus/rpc/RPCClient.cpp;quickbus/rpc/RPCServer.cpp;quickbus/rpc/RPCSessionID.cpp;quickbus/rpc/rpc_utils.cpp;quickbus/rpc/tests/qb_rpc_tests.cpp;quickbus/tests/quickbus_tests.cpp;sparkproto/SparkProtos.proto;testing/catch_test_runner.cpp;utils/AuthSessionManager.cpp;utils/AuthToken.cpp;utils/Dispatcher.cpp;utils/GrowableSPSCQueue.cpp;utils/HTTPStream.cpp;utils/PBUtils.cpp;utils/Puid.cpp;utils/SecureLogoLine truncated
+set(sources api/apicore.proto;api/apigateway.proto;api/apioptions.proto;api/core/ApiClientInterop.cpp;api/core/ApiServerInterop.cpp;api/public/ApiServer.cpp;api/public/ClientChannel.cpp;api/public/QuickbusClientChannel.cpp;api/public/ServerChannel.cpp;api/public/ServiceContext.cpp;api/service_helpers/AdminServiceUtils.cpp;api/service_helpers/AlgoServiceUtils.cpp;api/service_helpers/PositionUtilities.cpp;api/services/AdminService.proto;api/services/AlgoDefinitionService.proto;api/services/AlgoService.proto;api/services/ApiUnitTestService.proto;api/services/AuthService.proto;api/services/BasePositionService.proto;api/services/ErrorReportService.proto;api/services/HelloService.proto;api/services/MBOService.proto;api/services/MarginService.proto;api/services/MarketDataAuxiliaryService.proto;api/services/MarketDataRelay.proto;api/services/MoneyFileService.proto;api/services/OrderService.proto;api/services/OutOfProcessURLListener.proto;api/services/PersistenceService.proto;api/services/PositionService.proto;api/services/ShellDiagnosticService.proto;api/services/ShellLatencyService.proto;api/services/SyntheticSecurityService.proto;api/test/ApiTests.cpp;api/test/HelloServiceServer.cpp;config/ConfigCheck.cpp;config/ConfigDownloader.cpp;config/ConfigErrorCollector.cpp;config/ConfigLog.cpp;config/ConfigPropertyEvaluator.cpp;config/ConfigValueQueue.cpp;config/ConfigurationException.cpp;config/ConfigurationState.cpp;config/PreprocessInputStream.cpp;config/config.cpp;config/defaults/MarketData.conf;config/defaults/Ports.conf;config/defaults/Symbols.conf;config/defaults/cme_reference_data.conf;config/defaults/edge.conf;config/defaults/jetfix.conf;config/defaults/keycode.conf;config/defaults/logging.conf;config/defaults/orderman_cfg.conf;config/defaults/orders_fills_cleanup.conf;config/defaults/position_cfg.conf;config/defaults/span.conf;config/defaults/spreader.conf;config/defaults/testkeys.conf;config/defaults/threads.conf;config/defaults/toggles.conf;config/extensions/extensions.proto;config/invalid/invalid.proto;config/protos/ExchangeSimCfg.proto;config/protos/MarketData.proto;config/protos/Ports.proto;config/protos/Symbols.proto;config/protos/UI.proto;config/protos/cme_reference_data.proto;config/protos/jetfix.proto;config/protos/keycode.proto;config/protos/logging.proto;config/protos/mercury_cfg.proto;config/protos/orderman_cfg.proto;config/protos/orders_fills_cleanup.proto;config/protos/perflog_cfg.proto;config/protos/position_cfg.proto;config/protos/quickbus_cfg.proto;config/protos/span.proto;config/protos/spreader.proto;config/protos/subprocess.proto;config/protos/system.proto;config/protos/testkeys.proto;config/protos/threads.proto;config/protos/toggles.proto;config/tests/HTTPServer.cpp;config/tests/config_ref_tests.cpp;config/tests/config_tests.cpp;config/text_format/text_format.cpp;domain_model/Security.cpp;domain_model/Security.proto;domain_model/SecurityTests.cpp;domain_model/sod.cpp;domain_model/tests/domain_tests.cpp;expression/BooleanGrammar.cpp;expression/ExpressionEvaluator.cpp;expression/ParserExceptions.cpp;expression/Value.cpp;expression/tests/expression_parser_tests.cpp;logging/LoggerHub.cpp;logging/Sink.cpp;logging/logging.cpp;logging/tests/logging_tests.cpp;md/Diag/MDPeriodicDumper.cpp;md/Diag/ShmDumper.cpp;md/MBOProcessor.cpp;md/MBOServiceServer.cpp;md/MDClient.cpp;md/MDConsumer.cpp;md/MDConsumerHandle.cpp;md/MDConsumerInterop.cpp;md/MDProducer.cpp;md/MDProducerHandle.cpp;md/MemorySegmentUtils.cpp;md/PlatformLoader.cpp;md/PriceSize.cpp;md/SecurityCache.cpp;md/SecurityDB.cpp;md/SecurityIDRecorder.cpp;md/SecurityMapper.cpp;md/SecurityOracle.cpp;md/SettlementRecorder.cpp;md/Shm/FixedSecurity.cpp;md/SyntheticSecurityService.cpp;md/cme/MDP3Utils.cpp;md/common.cpp;md/ice/ICEUtils.cpp;md/protos/co2.proto;md/relay/QueryServer.cpp;md/relay/RelayClient.cpp;md/relay/RelayRecorder.cpp;md/test/Co2ManagedTestHelper.cpp;md/test/Co2TestInstrument.cpp;md/test/mbo_tests.cpp;md/test/md2_tests.cpp;md/test/md_test_utils.cpp;md/test/synthetic_book_merge_tests.cpp;md/vendor/OnixsUtils.cpp;os/os.cpp;os/tests/os_tests.cpp;quickbus/core/LocalNode.cpp;quickbus/core/Quickbus.cpp;quickbus/core/SubscriptionID.cpp;quickbus/core/TableID.cpp;quickbus/message_model/Update.cpp;quickbus/message_model/merge_updates.cpp;quickbus/network/QBConnection.cpp;quickbus/network/QBConnectionManager.cpp;quickbus/network/endpoint_description.cpp;quickbus/network/quickbus_msgs.proto;quickbus/pubsub/TablePublisher.cpp;quickbus/pubsub/TableSubscriber.cpp;quickbus/pubsub/tests/qb_pubsub_tests.cpp;quickbus/routing/INode.cpp;quickbus/routing/NodeID.cpp;quickbus/routing/Router.cpp;quickbus/rpc/RPCClient.cpp;quickbus/rpc/RPCServer.cpp;quickbus/rpc/RPCSessionID.cpp;quickbus/rpc/rpc_utils.cpp;quickbus/rpc/tests/qb_rpc_tests.cpp;quickbus/tests/quickbus_tests.cpp;sparkproto/SparkProtos.proto;testing/catch_test_runner.cpp;utils/AuthSessionManager.cpp;utils/AuthToken.cpp;utils/Dispatcher.cpp;utils/GrowableSPSCQueue.cpp;utils/HTTPStream.cpp;utils/PBUtils.cpp;Line truncated

src/lib/config/defaults/Symbols.conf

@@ -12,7 +12,9 @@ SymbolList {
         symbol: "BOB"
         symbol: "BUB"
         symbol: "BZ"
+        symbol: "BZT"
         symbol: "CL"
+        symbol: "CLT"
         symbol: "EH"
         symbol: "ES"
         symbol: "FYT"
@@ -22,6 +24,7 @@ SymbolList {
         symbol: "HE"
         symbol: "HG"
         symbol: "HO"
+        symbol: "HOT"
         symbol: "KE"
         symbol: "LE"
         symbol: "NB"
@@ -29,9 +32,11 @@ SymbolList {
         symbol: "NOB"
         symbol: "NON"
         symbol: "NG"
+        symbol: "NGT"
         symbol: "NQ"
         symbol: "NUB"
         symbol: "RB"
+        symbol: "RBT"
         symbol: "SI"
         symbol: "SOM"
         symbol: "SR1"
@@ -91,6 +96,10 @@ Symbols {
             future: @SymbolLists.list[GLBX].symbol
             spread: @SymbolLists.list[GLBX].symbol
         }
+        simice {
+            future: @SymbolLists.list[ICE].symbol
+            spread: @SymbolLists.list[ICE].symbol
+        }
     }
 }
 
@@ -101,6 +110,10 @@ Symbols {
             future: @SymbolLists.list[GLBX].symbol
             spread: @SymbolLists.list[GLBX].symbol
         }
+        ice {
+            future: @SymbolLists.list[ICE].symbol
+            spread: @SymbolLists.list[ICE].symbol
+        }
     }
 }
 

src/lib/config/defaults/position_cfg.conf

@@ -9,12 +9,12 @@ GMI_SymbolMap {
 }
 
 
-GMI_Import {
-   rule: "DeploymentType.type == 'DEV'"
-   value {
-       sftp_host: "10.96.18.41"
-       sftp_port: 22222
-       sftp_user: "PaTeACYB"
-       sftp_password: "DLXKuVK8"
-   }
-}
+#GMI_Import {
+#   rule: "DeploymentType.type == 'DEV'"
+#   value {
+#       sftp_host: "10.96.18.41"
+#       sftp_port: 22222
+#       sftp_user: "PaTeACYB"
+#       sftp_password: "DLXKuVK8"
+#   }
+#}

src/lib/config/protos/subprocess.proto

@@ -0,0 +1,16 @@
+syntax='proto2';
+package bts.subprocess;
+
+message Process {
+   required string exe = 1;
+   repeated string args = 2;
+   message Variable {
+      required string name = 1;
+      optional string value = 2;
+   }
+   repeated Variable env = 3;
+}
+
+message SubProcessList {
+   repeated Process process = 1;
+}

src/lib/logging/logging.cpp

@@ -118,7 +118,7 @@ void configure_logging(bts::config::Logging const&cfg, bts::config::ThreadGroupC
                                 {log::Latency,"Latency"},
                                 {log::DataFlow,"DataFlow"},
                                 {log::Plugin,"Plugin"},
-                                {log::ClientSdk,"ClientSdk"},
+                                {log::Sdk,"Sdk"},
                                 {log::Http,"Http"},
    };
 

src/lib/logging/logging.h

@@ -44,8 +44,8 @@ constexpr log::Subsystem Testing    {Mercury.ordinal+1     };
 constexpr log::Subsystem Latency    {Testing.ordinal+1     };
 constexpr log::Subsystem DataFlow   {Latency.ordinal+1     };
 constexpr log::Subsystem Plugin     {DataFlow.ordinal+1    };
-constexpr log::Subsystem ClientSdk  {Plugin.ordinal+1      };
-constexpr log::Subsystem Http       {ClientSdk.ordinal+1   };
+constexpr log::Subsystem Sdk        {Plugin.ordinal+1      };
+constexpr log::Subsystem Http       {Sdk.ordinal+1   };
 
 struct LoggerHandle {
    LoggerHandle(LoggerHandle const&) = delete;

src/lib/orderman/actors/ICEExecutionGateway.cpp

@@ -195,6 +195,10 @@ void ICEExecutionGateway::on_trader_login_timeout_expired()
             const auto& ice = u.user_data().exchange_user_data().ice_data();
             if(auth_traders.find(ice.authorized_trader()) == auth_traders.end())
             {
+               if(ice.authorized_trader() == "")
+                  continue;
+               if(ice.company_id() <= 0)
+                  continue;
                if(me->nusers == -1)
                   me->nusers = 0;
                me->nusers++;

src/lib/orderman/orders/algo/IBeforeLaunchAlgoServices.h

@@ -21,18 +21,19 @@ class IBeforeLaunchAlgoServices {
    // definition())
    virtual api::Security const &security() const = 0;
 
-   // The order key for this algo
+   // The unique order key for this algo
    virtual OrderKey order_key() const = 0;
 
-   // The parent key for this algo's parent (null_order_key() if the
-   // algo does not have a parent)
+   // The parent key for this algo's parent or null_order_key() if the
+   // algo does not have a parent
    virtual OrderKey parent_order_key() const = 0;
 
-   // The security identified by k or nullptr if no such security
-   // exists
+   // The security identified by k or nullptr if no such security exists
    virtual api::Security const *lookup_security(SecurityKey k) const = 0;
 
-   // Wheter this algo is being attached to an existing order
+   // Whether this algo is being attached to an existing order
+   // If an algo does not support attaching it can return an error 
+   // if is_attaching() == true from do_before_launch.
    virtual bool is_attaching() const = 0;
 
    // Build a child template that can later can be used to quickly
@@ -44,6 +45,7 @@ class IBeforeLaunchAlgoServices {
    make_child_template(api::orderman::OrderDefinition const &child_def,
                        size_t reserve = 1) = 0;
    
+   // Get the current time
    virtual TimeStamp get_time() const;
 };
 

src/lib/orderman/orders/algo/algo_orders/RegisterDorman.cpp

@@ -92,6 +92,9 @@ extern "C" void init_dorman_plugin(bts::SparkServices &srv) {
 
    join_desc.set_dynamic_order_type("Dorman");
 
+   *join_desc.add_param_desc() = param_array("what", param_double("").param_type());
+
+
    *join_desc.add_param_desc() = param_uint32("Market Quantity 1");
    *join_desc.add_param_desc() = param_uint32("Order Quantity 1");
    *join_desc.add_param_desc() = param_uint32("Market Quantity 2");
@@ -161,7 +164,7 @@ extern "C" void init_tas_plugin(bts::SparkServices& srv) {
 }
 
 extern "C" void init_spark_plugin(bts::SparkServices &srv) {
-   auto dyn_algo_config = config::get<config::toggles::DynamicAlgos>();
+   auto& dyn_algo_config = config::get<config::toggles::DynamicAlgos>();
    if(dyn_algo_config.enable_dorman())
       init_dorman_plugin(srv);
    if(dyn_algo_config.enable_pyramid())

src/lib/plugin/plugin.cpp

@@ -9,11 +9,14 @@
 #include <boost/dll.hpp>
 #include <boost/filesystem.hpp>
 
+extern "C" void init_spark_plugin(bts::SparkServices &serv);
+
 namespace bts {
 namespace plugin {
 
 using namespace bts::orderman;
 
+
 void init_plugins(SparkServices &services) {
 
    static std::vector<decltype(boost::dll::import<void(SparkServices &)>(
@@ -28,12 +31,15 @@ void init_plugins(SparkServices &services) {
       return;
    }
 
+   // initialize the plugins in libspark.so
+   init_spark_plugin(services);
+
    boost::filesystem::directory_iterator end;
    for (auto iter = boost::filesystem::directory_iterator(plugin_path);
         iter != end; ++iter) {
       auto &f = *iter;
 
-      auto pl = f.path().string();
+      auto pl = f.path().filename().string();
 
       if (pl == "order_plugin_example.so" &&
           config::get<config::DeploymentType>().type() != "dev") {
@@ -43,6 +49,8 @@ void init_plugins(SparkServices &services) {
          continue;
       }
 
+      if (pl == "libspark.so") continue;
+
       LOG(Plugin, Info, "Attempting to initialize plugin {}", pl);
       try {
          auto init_plugin = boost::dll::import<void(SparkServices &)>(

src/sdk/CMakeLists.txt

@@ -7,11 +7,14 @@ add_custom_command(OUTPUT ${CMAKE_BINARY_DIR}/sdk
   COMMENT "Building SDK"
   DEPENDS
   ${CMAKE_CURRENT_SOURCE_DIR}/make_sdk.sh
+  ${CMAKE_CURRENT_SOURCE_DIR}/Dockerfile
+  ${CMAKE_CURRENT_SOURCE_DIR}/sdk_spark.conf
   ${CMAKE_CURRENT_SOURCE_DIR}/README.md
   ${CMAKE_CURRENT_SOURCE_DIR}/sdk_shell.sh
+  ${CMAKE_CURRENT_SOURCE_DIR}/spark_client.cmd
   ${CMAKE_CURRENT_SOURCE_DIR}/examples/build_examples.sh
-  ${CMAKE_CURRENT_SOURCE_DIR}/examples/md_publisher_example.cpp
-  ${CMAKE_CURRENT_SOURCE_DIR}/examples/order_plugin_example.cpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/examples/md_publisher/md_publisher_example.cpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/examples/dynamic_join_order/order_plugin_example.cpp
   server_layout)
 
 add_custom_target(sdk_dir ALL DEPENDS ${CMAKE_BINARY_DIR}/sdk)

src/sdk/Dockerfile

@@ -0,0 +1,33 @@
+from bluetradingsystems/linux_docker
+
+
+# Set version with --build-arg SDK_VERSION=X
+# This lets us query an image to see when it was built
+ARG SDK_VERSION=0
+ARG SDK_BUILD_DATE=0
+ARG USERNAME=bts
+
+# configure build_examples
+env SDK_ROOT=/sdk \
+    SDK_VERSION=$SDK_VERSION \
+    SDK_BUILD_DATE=$SDK_BUILD_DATE
+
+# add user bts
+RUN groupadd --gid 1000 $USERNAME && \
+    useradd -s /bin/bash --uid 1000 --gid 1000 -m $USERNAME && \
+    mkdir -p /sparkbin/plugins && \
+    mkdir /sparkdata && \
+    ln -s /sparkbin/ sdk/lib && \
+    echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME && \
+    chmod 0440 /etc/sudoers.d/$USERNAME && \
+    chown -R bts.bts /sparkbin/plugins && \
+    chown -R bts.bts /sparkdata 
+
+# copy sdk
+COPY include/ /sdk/include/
+COPY lib/ /sparkbin/
+COPY externals /sdk/externals/
+COPY spark.conf /sparkdata/conf/
+COPY --chown=$USERNAME futures.coconut /sparkdata/data/replay/futures.coconut
+
+

src/sdk/disable_onixs.py

@@ -0,0 +1,13 @@
+#!/usr/bin/python
+
+import sys
+f = open(sys.argv[1], 'rb+')
+license = '5E50A1DACD94D7C1BECD316EEAE5AB02'
+data = f.read()
+match =  data.find(license)
+if match > 0:
+  f.seek(match)
+  f.write('DEAD'*8)
+  exit(0)
+exit(-1)
+

src/sdk/examples/algo_template/.devcontainer.json

@@ -0,0 +1,20 @@
+{
+   "name": "Spark sdk container",
+   "image": "spark_sdk",
+   "runArgs": [
+      "--shm-size", "1024m",
+      "--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined",
+      "-u", "bts"
+   ],
+   "settings": {
+      "terminal.integrated.shell.linux": "/bin/bash",
+      "C_Cpp.default.cppStandard": "c++20"
+   },
+   // use 9000 to avoid conflict with typical bts dev setup
+   "appPort": [9000,9001],
+   "postCreateCommand": "",
+   "extensions": [
+      "ms-vscode.cpptools"
+   ]
+}
+

src/sdk/examples/algo_template/.gitignore

@@ -0,0 +1 @@
+algo_template.so 

src/sdk/examples/algo_template/.vscode/c_cpp_properties.json

@@ -0,0 +1,21 @@
+{
+    "configurations": [
+        {
+            "name": "Linux",
+            "includePath": [
+                "/usr/include",
+                "/usr/local/include",
+                "${workspaceFolder}/**",
+                "/sdk/include/",
+                "/sdk/include/spark",
+                "/sdk/externals/include"
+            ],
+            "defines": [],
+            "compilerPath": "/usr/bin/clang",
+            "cStandard": "c11",
+            "cppStandard": "c++17",
+            "intelliSenseMode": "clang-x64"
+        }
+    ],
+    "version": 4
+}

src/sdk/examples/algo_template/.vscode/launch.json

@@ -0,0 +1,27 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "(gdb) Launch",
+            "type": "cppdbg",
+            "request": "launch",
+            "program": "/sparkbin/sparkd",
+            "args": ["run"],
+            "stopAtEntry": false,
+            "cwd": "/sparkbin",
+            "environment": [],
+            "externalConsole": false,
+            "MIMode": "gdb",
+            "setupCommands": [
+                {
+                    "description": "Enable pretty-printing for gdb",
+                    "text": "-enable-pretty-printing",
+                    "ignoreFailures": true
+                }
+            ]
+        }
+    ]
+}

src/sdk/examples/algo_template/.vscode/tasks.json

@@ -0,0 +1,29 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    // variables: ${workspaceRoot}
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "build",
+            "type": "shell",
+            "command": "./build.sh",
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            }
+        },
+        {
+            "label": "Start Sparkd",
+            "type": "shell",
+            "command": "cd /sparkbin; ./sparkd run",
+            "isBackground": true,
+            "problemMatcher": []
+        },
+        {
+            "label": "Stop Sparkd",
+            "type": "shell",
+            "command": "pkill -f sparkd"
+        }
+    ]
+}

src/sdk/examples/algo_template/algo_template.cpp

@@ -0,0 +1,132 @@
+#include "spark/lib/config/config.h"
+#include "spark/lib/config/protos/system.pb.h"
+#include "spark/lib/domain_model/Security.h"
+#include "spark/lib/orderman/orders/algo/IAlgoOrder.h"
+#include "spark/lib/orderman/orders/algo/IAlgoServices.h"
+#include "spark/lib/plugin/SparkServices.h"
+
+#include "spark/lib/orderman/order_factory/IOrderFactory.h"
+#include "spark/lib/orderman/orderman_utils/Book.h"
+#include "spark/lib/orderman/orderman_utils/orderman_utils.h"
+#include "spark/lib/utils/PBUtils.h"
+
+using namespace bts::api::orderman;
+using namespace bts::orderman;
+
+namespace bts {
+namespace order_example {
+
+// MyAlgo is a blank IAlgoOrder which you can copy when starting a new Algo
+class MyAlgo : public IAlgoOrder {
+ public:
+   MyAlgo();
+   ~MyAlgo();
+
+   OrderOpResult do_before_launch(IBeforeLaunchAlgoServices &) override;
+   void do_launch(IAlgoServices &) override;
+   void do_launch_attached(IAlgoServices &, OrderKey, ChildState) override;
+   void do_update(api::orderman::Update const &) override;
+   void on_book(SecurityKey, Book const &) override;
+   void on_child_change(OrderKey, ChildState const &) override;
+
+ private:
+   IAlgoServices* algo_services;
+   ChildTemplate *child_template = nullptr;
+   OrderKey child_key = null_order_key();
+};
+
+
+MyAlgo::MyAlgo() : algo_services(nullptr) {}
+MyAlgo::~MyAlgo() {}
+
+// This is called outside of the latency sensitive path. 
+// Expensive initialization should be done here, rather than in do_launch()
+OrderOpResult MyAlgo::do_before_launch(IBeforeLaunchAlgoServices &serv) {
+   LOG(Sdk,Info, "MyAlgo: do_before_launch");
+   // If we are not attaching, create a child template so we can
+   // quickly launch our child when the time comes.
+   if (!serv.is_attaching()) {
+      // We will be sending a limit order with the same side,
+      // security, trader, account, etc, as this algo order, so just
+      // copy our definition to the child definition to start with.
+      auto child_def = serv.definition();
+      // Now add a limit order component to mark our child as a limit
+      // order. Limit orders do not require any extra parameters
+      // beyond those already inherited from this algo order
+      // (i.e. beyond what we obtained through serv.definition()) so
+      // we can just use a default constructed LimitOrderDefinition.
+      *child_def.mutable_custom_def()->mutable_limit() = LimitOrderDefinition{};
+      // Now just build the child template and cache it for future use
+      child_template = &(serv.make_child_template(child_def));
+   }
+   // Default constructed result is successful
+   return {};
+}
+
+// Called in the latency sensitive path, once, when the algo is first launched. 
+// If the Algo is attaching to an existing order do_launch_attached is called instead.
+void MyAlgo::do_launch(IAlgoServices &services) {
+   algo_services = &services;
+   // Subscribe to book updates for this security
+   services.subscribe_book(SecurityKey(services.security().id()));
+   // Launch a child limit order
+   child_key = 
+      services.launch_child(*child_template, services.price(), services.quantity());
+   LOG(Sdk,Info, "MyAlgo: do_launch");
+}
+
+// Called in the latency sensitive path, once, when the algo is first
+// launched. In this case the algo is provided with an existing order
+// it is now responsible for managing.
+void MyAlgo::do_launch_attached(IAlgoServices &services,
+                                OrderKey attached_order, ChildState st) {
+   algo_services = &services;
+   // Subscribe to book updates for this security
+   services.subscribe_book(SecurityKey(services.security().id()));
+   // Keep track of the child key
+   child_key = attached_order;
+   LOG(Sdk,Info, "MyAlgo: do_launch_attached");
+}
+
+// Called when a human (or a supervising algo) updates a parameter for
+// this algo. The implementation validates the update and depending on
+// the validation outcome either applies the update or terminates the algo.
+void MyAlgo::do_update(api::orderman::Update const &update) {
+}
+
+// Called when the book for the specified security has changed
+void MyAlgo::on_book(SecurityKey, Book const &b) {
+}
+
+// Our child reported a change
+void MyAlgo::on_child_change(OrderKey, ChildState const &st) {
+}
+
+// This is called by the spark daemon at startup. In this call we
+// describe our algo's parameters and register a factory function to
+// create an instance of the algo.
+extern "C" void init_spark_plugin(bts::SparkServices &serv) {
+   using namespace bts;
+
+   DynamicOrderDescriptor desc;
+
+   // Start by naming our order type
+   desc.set_dynamic_order_type("My Algo");
+
+   *desc.add_param_desc() = param_bool("Enable Feature");
+   *desc.add_param_desc() = param_uint32("Feature Quantity");
+
+   // Associate the descriptor with a builder function and register
+   // that with the Spark server.
+   auto result = 
+      serv.register_dynamic_algo_order(
+       desc, []() { return std::make_unique<MyAlgo>(); });
+
+   if (result != bts::AlgoRegistrationResult::SUCCESS) {
+      // The desc has errors
+      // Check the error log (/sparkdata/data/logging/log) for more details
+   }
+}
+
+} // namespace order_example
+} // namespace bts

src/sdk/examples/algo_template/build.sh

@@ -0,0 +1,29 @@
+#!/bin/bash
+set -e
+
+SDK_ROOT=${SDK_ROOT:-../..}
+PLUGIN_NAME=algo_template
+
+g++ -isystem $SDK_ROOT/externals/include \
+    -I $SDK_ROOT/include \
+    -I $SDK_ROOT/include/spark \
+    -std=c++1z \
+    -fPIC \
+    -g \
+    -shared \
+    -o $PLUGIN_NAME.so \
+    $PLUGIN_NAME.cpp \
+    -Wl,-rpath,$SDK_ROOT/ \
+    -L $SDK_ROOT/lib  \
+    -l spark 
+
+# If we're in the sdk docker copy to /sparkbin
+yellow=$'\e[1;33m'
+end=$'\e[0m'
+if [ "${SDK_VERSION}" != "" ]; then
+   cp $PLUGIN_NAME.so /sparkbin/plugins/
+   echo $PLUGIN_NAME.so copied to /sparkbin/plugins/
+   echo ${yellow}Restart sparkd to see changes.${end}
+fi
+
+

src/sdk/examples/build_examples.sh

@@ -1,26 +1,15 @@
 #!/bin/bash
 
-g++ -isystem ../externals/include \
-    -I ../include \
-    -I ../include/spark \
-    -std=c++1z \
-    -o md_publisher_example \
-    md_publisher_example.cpp \
-    -Wl,-rpath,../lib \
-    -L ../lib  \
-    -l spark \
-    -llttng-ust \
-    -ldl
-    
-g++ -isystem ../externals/include \
-    -I ../include \
-    -I ../include/spark \
-    -std=c++1z \
-    -fPIC \
-    -g \
-    -shared \
-    -o order_plugin_example.so \
-    order_plugin_example.cpp \
-    -Wl,-rpath,.. \
-    -L ../lib  \
-    -l spark 
+# exit when the first build fails
+set -e
+
+for e in *; do
+   if [ -d $e ]
+   then
+      pushd $e > /dev/null
+      if [ -f ./build.sh ]; then
+         ./build.sh
+      fi
+      popd > /dev/null
+   fi
+done

src/sdk/examples/dynamic_join_order/.devcontainer.json

@@ -0,0 +1,20 @@
+{
+   "name": "Spark sdk container",
+   "image": "spark_sdk",
+   "runArgs": [
+      "--shm-size", "1024m",
+      "--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined",
+      "-u", "bts"
+   ],
+   "settings": {
+      "terminal.integrated.shell.linux": "/bin/bash",
+      "C_Cpp.default.cppStandard": "c++20"
+   },
+   // use 9000 to avoid conflict with typical bts dev setup
+   "appPort": [9000,9001],
+   "postCreateCommand": "",
+   "extensions": [
+      "ms-vscode.cpptools"
+   ]
+}
+

src/sdk/examples/dynamic_join_order/.gitignore

@@ -0,0 +1 @@
+order_plugin_example.so 

src/sdk/examples/dynamic_join_order/.vscode/c_cpp_properties.json

@@ -0,0 +1,21 @@
+{
+    "configurations": [
+        {
+            "name": "Linux",
+            "includePath": [
+                "/usr/include",
+                "/usr/local/include",
+                "${workspaceFolder}/**",
+                "/sdk/include/",
+                "/sdk/include/spark",
+                "/sdk/externals/include"
+            ],
+            "defines": [],
+            "compilerPath": "/usr/bin/clang",
+            "cStandard": "c11",
+            "cppStandard": "c++17",
+            "intelliSenseMode": "clang-x64"
+        }
+    ],
+    "version": 4
+}