feat: conan lock files, housekeeping

Author: milsanore

.github/workflows/clean_build_test.yml

@@ -46,7 +46,7 @@ jobs:
           set -e
           rm -rf build
           conan profile detect --force
-          conan install . --build=missing -s build_type=Debug
+          conan install . --lockfile=conan.lock --build=missing -s build_type=Debug
 
       - name: Build
         run: |

.github/workflows/cron.yml

@@ -3,8 +3,7 @@ name: Daily
 on:
   schedule:
     - cron: '0 0 * * *'  # Runs every day at midnight UTC
-
-# workflow_dispatch: # Allows manual triggering
+  workflow_dispatch:  # Allows manual run from GitHub UI
 
 jobs:
   call-reusable:

.github/workflows/release.yml

@@ -3,7 +3,7 @@ name: Release
 on:
   release:
     types: [published]  # Triggers when a release is published
-  workflow_dispatch:     # Allows manual run from GitHub UI
+  workflow_dispatch:  # Allows manual run from GitHub UI
 
 jobs:
   build_release:
@@ -25,7 +25,7 @@ jobs:
           set -e
           rm -rf build
           conan profile detect --force
-          conan install . --build=missing -s build_type=Release
+          conan install . --lockfile=conan.lock --build=missing -s build_type=Release
 
       - name: Build
         run: |

.vscode/tasks.json

@@ -7,7 +7,7 @@
       "command": "bash",
       "args": [
         "-c",
-        "source .venv/bin/activate && conan install . --build=missing -s build_type=Debug && cmake --preset=debug && cmake --build --preset=debug"
+        "source .venv/bin/activate && conan install --lockfile=conan.lock . --build=missing -s build_type=Debug && cmake --preset=debug && cmake --build --preset=debug"
       ],
       "group": {
         "kind": "build",

Dockerfile

@@ -5,32 +5,38 @@
 
 FROM milss/tradercppbuild:v1.6 AS build_container
 
+LABEL org.opencontainers.image.title="tradercpp" \
+    org.opencontainers.image.description="Container for running the trader.cpp app" \
+    org.opencontainers.image.source="https://github.com/milsanore/trader.cpp" \
+    maintainer="Milsanore <your@email>"
+
 WORKDIR /tradercpp
 
 COPY src/ ./src/
 COPY tests/ ./tests/
 COPY CMakeLists.txt .
 COPY CMakePresets.json .
 COPY conanfile.txt .
+COPY conan.lock .
 COPY Makefile .
-
 RUN make init
 RUN make build-debug
 RUN make test
 
+# ------------------------------------
 
 COPY binance/fixconfig .
 COPY binance/spot-fix-md.xml .
 COPY binance/stunnel_prod.conf .
-# COPY binance/keys/prod-key-prv.pem .
+# COPY binance/keys/key.pem .
 
 FROM alpine
 WORKDIR /tradercpp
 
 COPY --from=build_container /tradercpp/fixconfig            /tradercpp/binance/fixconfig
 COPY --from=build_container /tradercpp/spot-fix-md.xml      /tradercpp/binance/spot-fix-md.xml
 COPY --from=build_container /tradercpp/stunnel_prod.conf    /tradercpp/binance/stunnel_prod.conf
-# COPY --from=build_container /tradercpp/prod-key-prv.pem     /tradercpp/binance/keys/prod-key-prv.pem
+# COPY --from=build_container /tradercpp/key.pem              /tradercpp/binance/keys/key.pem
 
 COPY --from=build_container /tradercpp/build/Debug/tradercpp /tradercpp/tradercpp
 ENTRYPOINT ["/tradercpp/tradercpp"]

Dockerfile_build

@@ -14,9 +14,13 @@
 #  - coverage (lcov, gcovr)
 #############################################
 
-
 FROM ubuntu:24.04 AS build_container
 
+LABEL org.opencontainers.image.title="tradercppbuild" \
+    org.opencontainers.image.description="Container for building the trader.cpp app" \
+    org.opencontainers.image.source="https://github.com/milsanore/trader.cpp" \
+    maintainer="https://github.com/milsanore"
+
 # Set noninteractive mode to avoid prompts during install
 ENV DEBIAN_FRONTEND=noninteractive
 

Makefile

@@ -13,7 +13,7 @@ help: Makefile
 	@echo " Choose a command to run:"
 	@sed -n 's/^##//p' $< | column -t -s ':' | sed -e 's/^/ /'
 
-## withenv: 😭 `make` executes every line as a new shell. this is a workaround => `make withenv RECIPE=init`
+## withenv: 😭 run `make` with envars from `.env`. like so `make withenv RECIPE=init`
 .PHONY: withenv
 withenv:
 	test -e .env || cp .env.example .env
@@ -26,35 +26,26 @@ init:
 	python3 -m venv .venv
 	source .venv/bin/activate && \
 		pip install gcovr conan && \
-		conan install . --build=missing -s build_type=Debug
+		conan install . --lockfile=conan.lock --build=missing -s build_type=Debug
 	cmake --preset=debug
 
-## build-container: 🚢 create the docker container for building the app (hosted on dockerhub and ghcr)
-.PHONY: build-container
-build-container:
-	IMAGE_VERSION=
-	@if [ -z "$(IMAGE_VERSION)" ]; then \
-		echo "Error: IMAGE_VERSION is not set"; \
-		echo "(you can set it on the command line like so: \`make build-container IMAGE_VERSION=1.6\`)"; \
-		exit 1; \
-	fi
-	docker build -f Dockerfile_build -t milss/tradercppbuild:latest -t milss/tradercppbuild:v$(IMAGE_VERSION) .
-
-## docker: 🚢 create an app docker image
-.PHONY: docker
-docker:
-	docker build .
+## lock-conan: 📦 run after installing conan dependencies
+.PHONY: lock-conan
+lock-conan:
+	conan lock create . --profile:host=default -s build_type=Debug --lockfile-out=conan.lock
+	conan lock create . --profile:host=default -s build_type=Release --lockfile=conan.lock --lockfile-out=conan.lock
 
 ## build-debug: 🔨 compile (debug)
 .PHONY: build-debug
 build-debug:
+	$(call pp,assuming `make init` has been called)
 	cmake --build --preset=debug
 
 ## build-release: 🏎️ compile (prod)
 .PHONY: build-release
 build-release:
 	source .venv/bin/activate && \
-		conan install . --build=missing -s build_type=Release
+		conan install . --lockfile=conan.lock --build=missing -s build_type=Release
 	cmake --preset=release
 	cmake --build --preset=release
 

README.md

@@ -3,16 +3,28 @@
 [![codecov](https://codecov.io/github/milsanore/trader.cpp/graph/badge.svg?token=C787ZTXBQC)](https://codecov.io/github/milsanore/trader.cpp)
 
 <img src="docs/app.gif" alt="trader.cpp" width="800" />
-<br/>
-<br/>
 
 # trader.cpp
 Small trading UI connected to Binance over their FIX API.<br/>
 A proof-of-concept, showcasing some modern c++ and some fintech concepts.
 
 ## Run Requirements
-- a Binance account, with an Ed25519 token that has FIX read permissions enabled 
+- linux (tested with debian-trixie)
 - `stunnel` for TLS encryption (or a local proxy)
+- a Binance account, and an Ed25519 token with FIX read permissions enabled
+
+## Run
+- start an SSL tunnel
+  - e.g. run `stunnel stunnel_prod.conf` (from the binance folder)
+- configure:
+  - copy `fixconfig` (from the binance folder)
+  - copy `spot-fix-md.xml` (from the binance folder) and edit references in fixconfig
+  - copy your binance private key pem and your public api key
+  - copy `.env.example` to `.env`, edit values, and source the file
+- run:
+  - download release
+  - `chmod u+x tradercpp`
+  - `./tradercpp`
 
 ## Build Requirements
 - C++20
@@ -78,6 +90,7 @@ NB: this app uses `make` as a recipe book, but it's not essential:
   - update balance for in-flight orders (reconcile asynchronously)
 
 ## Non-functional
+- ✅ package management (Conan 2 + lock file)
 - ✅ QuickFIX
 - ✅ basic cpp app to start with
 - ✅ makefile and build chain
@@ -121,17 +134,21 @@ NB: this app uses `make` as a recipe book, but it's not essential:
   - Valgrind
 - pipeline
   - ✅ custom docker build image with all dependencies (hosted on GHCR for faster pipelines)
+  - ✅ reusable pipeline components + Release pipeline
+  - https://github.com/googleapis/release-please 
   - ✅ cron
     - ✅ comprehensive clang-tidy & clang-format checks
     - ✅ sonarcloud
-  - ccache or precomiled headers
+  - ✅ cached dependencies
+  - containerised pipeline integration tests / dind
+  - https://github.com/googleapis/release-please
   - local github action runner (`act`)
-  - containerised integration tests / dind
+  - ccache or precomiled headers
 - testing
+  - ✅ coverage gutters
   - ✅ dependency injection
   - integration test with mocked Binance server
   - UI snapshot testing
-  - ✅ coverage gutters
 - performance
   - ✅ store prices and sizes as integrals (ticks as `uint64_t`) for performance
   - release compile flags

conan.lock

@@ -0,0 +1,27 @@
+{
+    "version": "0.5",
+    "requires": [
+        "zlib/1.3.1#b8bc2603263cf7eccbd6e17e66b0ed76%1733936244.862",
+        "spdlog/1.15.3#3ca0e9e6b83af4d0151e26541d140c86%1748617970.519",
+        "quickfix/1.15.1#fe4ca02d3a021859ba9673f5d481f31d%1691409263.817",
+        "openssl/3.5.2#0c5a5e15ae569f45dff57adcf1770cf7%1754407017.477",
+        "ms-gsl/4.2.0#eb8e3068d01908f5c6fed255fc0d4098%1745345253.347",
+        "libsodium/1.0.20#d2baa92ed999abe295ff63e2ee25b4f3%1743063880.072",
+        "libbacktrace/cci.20210118#a7691bfccd8caaf66309df196790a5a1%1722218217.276",
+        "gtest/1.17.0#5224b3b3ff3b4ce1133cbdd27d53ee7d%1755784855.585",
+        "ftxui/6.0.2#1b49d899f377591328fd17df1b3fd98e%1744735500.697",
+        "fmt/11.2.0#579bb2cdf4a7607621beea4eb4651e0f%1746298708.362",
+        "efsw/1.4.1#a4dc44b2fa9fa5a55081e365b1301d4c%1731488680.092",
+        "concurrentqueue/1.0.4#1e48e1c712bcfd892087c9c622a51502%1687274728.048",
+        "bzip2/1.0.8#00b4a4658791c1f06914e087f0e792f5%1744702067.178",
+        "boost/1.88.0#6e3079d628a51513bfff72f3ee17668f%1759416413.7",
+        "abseil/20250814.0#4e0fdd34a888b97aca482e648fc27a3b%1758546438.307"
+    ],
+    "build_requires": [
+        "cmake/4.1.1#23ee27eac0192593228fe8ced4680627%1756413041.241",
+        "cmake/3.31.8#dde3bde00bb843687e55aea5afa0e220%1751628300.59",
+        "b2/5.3.3#107c15377719889654eb9a162a673975%1750340310.079"
+    ],
+    "python_requires": [],
+    "config_requires": []
+}

src/README.md

@@ -1,14 +1,25 @@
 # NOTES
-- c++ namespace names map to the first level of subdirectories in src/
+- namespaces map to the first level of subdirectories in src/
 
 # SUBFOLDERS
-- binance
-    - FIX connectivity to the Binance exchange
-- core
-    - core trading engine functionality
-    - e.g. the order book
-- ui
-    - a basic terminal ui written using the c++ `ftxui` library (similar to ncurses)
-
-## UTILS
-- os-specific stuff
+
+## binance
+- Classes that faciliate connectivity to the Binance crypto exchange using the FIX protocol and the c++ "QuickFIX" library
+- Pushes updates to two concurrent queues, that downstream consumers can use:
+    1. order updates (prices/volumes)
+    2. trade updates
+- NB: Binance uses a custom authentication mechanism
+
+## core
+- core trading engine functionality
+- e.g. the order book
+- some coupling to the binance namespace (symbol, side, and multiplier values).
+- TODO(mils): move out.
+
+## ui
+- a basic terminal ui written using the c++ `ftxui` library (similar to ncurses)
+- work done predominantly on background threads
+
+## utils
+- helpers
+- non-portable (OS-specific) stuff