TraderX is a Sample Trading Application, designed to be a distributed reference application in the financial services domain which can serve as a starting point for experimentation with various techniques and other open source projects. It is designed to be simple and accessible to developers of all backgrounds, with minimal pre-assumptions, and it can serve as a starting point for educational and experimentation purposes.
It is designed to be runnable from any developer workstation with minimal assumptions other than Node, Java and Python runtimes. The libraries and toolkits it uses are meant to be as vanilla as possible, to preserve its approachability by developers of all levels.
It contains Java, NodeJS, Python, .NET components that communicate over REST APIs and messaging systems and are able to showcase a wide range of technical challenges to solve.
More detailed information about this project can be found in the website which is generated
from the code under the docs directory of this project.
Learn more about the project - including a brief demo, in the Keynote Demo session that was presented at the Open Source in Finance Forum 2023
The project consists of multiple moving parts, and you can see how things hang together by reviewing the architecture and sequence diagrams located in the docs directory.
| Component | Tech Stack | Description |
|---|---|---|
| docs | markdown | Architecture and Flow Diagrams are here! |
| database | java/h2 | A simple self-contained SQL database |
| reference-data | node/nestjs | REST service (off a flat file) for querying ticker symbols |
| trade-feed | node/socketio | Message bus used for trade flows, as well as streaming to the GUI |
| people-service | .Net core | Service for looking up users, for account mangement |
| account-service | java/spring | Service for querying and validating accounts |
| position-service | java/spring | Position service for looking up positions and trades by the blotter |
| trade-service | java/spring | Service for submitting trade/order requests for further processing |
| trade-processor | java/spring | Trade Feed consumer which processes trade/orders |
| web-front-end | html/angular or react | Interactive UI for executing trades and viewing blotter. Note: the AngularJS GUI was an initial contribution and contains account management capabilities. The React GUI was contributed during a hack day and may not work for managing accounts, but it does work for executing trades and viewing the blotter |
This is installed locally through normal git clone operations.
In order to get things working together, it is recommended to select a range of ports to provide all running processes with, so that the pieces can interconnect as needed. To run this all up 'by hand' here are default ports which are used, and you can easily export these variables to your favorite shell.
export DATABASE_TCP_PORT=18082
export DATABASE_PG_PORT=18083
export DATABASE_WEB_PORT=18084
export REFERENCE_DATA_SERVICE_PORT=18085
export TRADE_FEED_PORT=18086
export ACCOUNT_SERVICE_PORT=18088
export PEOPLE_SERVICE_PORT=18089
export POSITION_SERVICE_PORT=18090
export TRADE_PROCESSOR_SERVICE_PORT=18091
export TRADING_SERVICE_PORT=18092
export WEB_SERVICE_ANGULAR_PORT=18093 #Angular
export WEB_SERVICE_REACT_PORT=18094 #ReactThe recommended starting sequence to let everything find what it needs is:
database
reference-data
trade-feed
people-service
account-service
position-service
trade-processor
trade-service
web-front-endThe easiest way to run up the entire system is using Docker Compose. This should work on your local computer using Docker Desktop / Docker Compose (tested on Mac Silicon) and also in Github Codespaces.
If using Github Codespaces it is recommended you select an 8-core type machine with 32GB RAM to ensure all the components have the required resources to start.
To do this
- Select the Green Code menu at the top of this page
- Select the Codespace tab then click the three dots '...' and select 'New with options...'.
- Change the machine type to '8-core' and click 'Create codespace'
As of writing, personal Github accounts receive 120 free core hours per month for using Codespaces, see the most recent details here
Once you have cloned the repository locally or once your Codespace has started, from the root traderX directory run
docker compose up
On first run this will build all of the containers from the project specific Dockerfile's and then start them in the correct sequence.
The Docker containers are configured via Docker Compose to connect to a shred virtual network enabling them to communciate whether running on your local computer or via a Codespace.
Once everything has started the WebUI will be accessible at http://localhost:8080 (even if using a codespace, the localhost URL will be mapped through from your local browser to the Codespace).
When building locally in your company, if you are using a corporate artifact repository, you might need to override certain settings such as mavenCentral() in gradle, for the Java projects.
In order to do this, we have designated a .gitignore'd folder where you can leave company-specific build scripts. This folder is not managed by git and can be modified locally.
Create a .corp directory and in there you can create a settings.gradle file which will allow you to build all gradle projects
# in the traderX main directory
mkdir .corp
touch settings.gradleThe settings.gradle file should contain any overrides on your repositories and plugins block but should also contain these contents:
rootProject.name = 'finos-traderX'
includeFlat 'database'
includeFlat 'account-service'
includeFlat 'position-service'
includeFlat 'trade-service'
includeFlat 'trade-processor'This will include projects in directories at the same level as the .corp directory.
You can also store a separate gradle wrapper here, if you need the distributionUrl in your gradle.properties to differ from the public internet one.
To build and run these projects, you can do the following:
###### From traderX root #####
# Note: gradle or ./gradlew can be used, depending on your path
gradle --settings-file .corp/settings.gradle build
# Build specific project
gradle --settings-file .corp/settings.gradle database:build
# Run specific project
gradle --settings-file .corp/settings.gradle account-service:bootRun
##### From inside the .corp directory ####
cd .corp
./gradlew build
./gradlew account-service:bootRunThe following are instructions to build and deploy all TraderX apps to your local enviroment using tilt and kustomize files.
- Running Docker or similar
- Running K8s - Kind /Minikube/k3s or similar
- Install an Ingress Controller
kubectl get pods
or
Check your cluster is running using the epic tool k9s - https://k9scli.io/
This command will build and start all locally built applications and deploy them to your local K8s environment.
cd ./gitops/local/
tilt up
A great way to interact with the TraderX community is to attend the bi-weekly Friday TraderX meetings. Email help@finos.org to be added to the meeting invite directly, or find the meeting in the FINOS Community Calendar.
- Fork it (https://github.com/finos/traderx/fork)
- Create your feature branch (
git checkout -b feature/fooBar) - Read our contribution guidelines and Community Code of Conduct
- Commit your changes (
git commit -am 'Add some fooBar') - Push to the branch (
git push origin feature/fooBar) - Create a new Pull Request
NOTE: Commits and pull requests to FINOS repositories will only be accepted from those contributors with an active, executed Individual Contributor License Agreement (ICLA) with FINOS OR who are covered under an existing and active Corporate Contribution License Agreement (CCLA) executed with FINOS. Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS Clabot tool. Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA.
Need an ICLA? Unsure if you are covered under an existing CCLA? Email help@finos.org
Copyright 2023 UBS, FINOS, Morgan Stanley
Distributed under the Apache License, Version 2.0.
SPDX-License-Identifier: Apache-2.0