Ecosystem
The Virtufin platform is a federation of focused repos. Each repo ships its own documentation site; the sites cross-link so a developer can find related material without leaving the platform.
Solid arrows are real dependencies (package/build-time); dashed arrows are "deploys" relationships (for benchmarks: "measures"), not code dependencies. Click any node to open its docs site (or repo page, where no docs site exists).
graph TD
subgraph Foundation
lib["lib<br/>.NET core libraries"]
openspec["openspec<br/>domain spec"]
common["common<br/>CI/build tooling for all repos"]
end
subgraph "Core services"
api["api<br/>API gateway"]
service["service<br/>(archived, folded into api)"]
wm["workmanager"]
wsm["websocketmanager<br/>(archived, replaced by WebSocketFeed)"]
end
subgraph "Dev kits"
workerdevkit["worker-devkit<br/>worker authoring toolkit (generic)"]
domaindevkit["domain-devkit<br/>domain envelope, worlds"]
stratdevkit["strategy-devkit"]
execdevkit["execution-devkit"]
indicdevkit["indicator-devkit"]
mddevkit["market-data-devkit"]
pfdevkit["portfolio-devkit"]
end
subgraph "Deployable workers"
strategies["strategy-workers"]
execengines["execution-workers"]
indengines["indicator-workers"]
mdengines["market-data-workers"]
pfworkers["portfolio-workers"]
workers["general-workers"]
examples["examples"]
end
subgraph Frontends
tui["tui"]
app["app"]
site["site"]
end
subgraph Deployment
helm["helm"]
deploylocal["deploy-local"]
dockercompose["docker-compose<br/>(archived)"]
end
subgraph Reports
benchmarks["benchmarks<br/>WorkManager benchmark results"]
end
docs["docs<br/>(this site)"]
wm --> api
workerdevkit --> lib
workerdevkit --> wm
domaindevkit --> lib
domaindevkit --> workerdevkit
stratdevkit --> lib
stratdevkit --> wm
stratdevkit --> workerdevkit
stratdevkit --> domaindevkit
stratdevkit --> pfdevkit
execdevkit --> lib
execdevkit --> wm
execdevkit --> workerdevkit
execdevkit --> domaindevkit
indicdevkit --> lib
indicdevkit --> wm
indicdevkit --> api
indicdevkit --> workerdevkit
indicdevkit --> domaindevkit
mddevkit --> lib
mddevkit --> wm
mddevkit --> workerdevkit
mddevkit --> domaindevkit
pfdevkit --> lib
pfdevkit --> workerdevkit
pfdevkit --> domaindevkit
strategies --> wm
strategies --> stratdevkit
strategies --> workerdevkit
execengines --> wm
execengines --> execdevkit
execengines --> workerdevkit
indengines --> wm
indengines --> indicdevkit
indengines --> workerdevkit
indengines --> mddevkit
mdengines --> wm
mdengines --> mddevkit
mdengines --> workerdevkit
mdengines --> api
pfworkers --> wm
pfworkers --> pfdevkit
pfworkers --> workerdevkit
pfworkers --> api
workers --> wm
workers --> api
workers --> workerdevkit
examples --> wm
examples --> api
examples --> stratdevkit
examples --> execdevkit
examples --> indicdevkit
examples --> mddevkit
examples --> workerdevkit
examples -.-> strategies
examples -.-> execengines
examples -.-> indengines
examples -.-> mdengines
tui --> api
app --> api
app --> wm
helm -.-> api
helm -.-> wm
deploylocal -.-> api
deploylocal -.-> wm
benchmarks -.-> wm
click lib "https://lib.docs.virtufin.com" "lib docs" _blank
click openspec "https://specs.docs.virtufin.com" "openspec docs" _blank
click common "https://git.haenerconsulting.com/virtufin/common" "common repo" _blank
click api "https://api.docs.virtufin.com" "api docs" _blank
click service "https://git.haenerconsulting.com/virtufin/service" "service repo" _blank
click wm "https://workmanager.docs.virtufin.com" "workmanager docs" _blank
click wsm "https://git.haenerconsulting.com/virtufin/websocketmanager" "websocketmanager repo (archived)" _blank
click workerdevkit "https://worker-devkit.docs.virtufin.com" "worker-devkit docs" _blank
click domaindevkit "https://domain-devkit.docs.virtufin.com" "domain-devkit docs" _blank
click stratdevkit "https://strategy-devkit.docs.virtufin.com" "strategy-devkit docs" _blank
click execdevkit "https://execution-devkit.docs.virtufin.com" "execution-devkit docs" _blank
click indicdevkit "https://indicator-devkit.docs.virtufin.com" "indicator-devkit docs" _blank
click mddevkit "https://market-data-devkit.docs.virtufin.com" "market-data-devkit docs" _blank
click pfdevkit "https://portfolio-devkit.docs.virtufin.com" "portfolio-devkit docs" _blank
click strategies "https://strategy-workers.docs.virtufin.com" "strategy-workers docs" _blank
click execengines "https://execution-workers.docs.virtufin.com" "execution-workers docs" _blank
click indengines "https://indicator-workers.docs.virtufin.com" "indicator-workers docs" _blank
click mdengines "https://market-data-workers.docs.virtufin.com" "market-data-workers docs" _blank
click pfworkers "https://portfolio-workers.docs.virtufin.com" "portfolio-workers docs" _blank
click workers "https://general-workers.docs.virtufin.com" "general-workers docs" _blank
click examples "https://examples.docs.virtufin.com" "examples docs" _blank
click tui "https://tui.docs.virtufin.com" "tui docs" _blank
click app "https://app.docs.virtufin.com" "app docs" _blank
click site "https://www.virtufin.com" "virtufin site" _blank
click helm "https://git.haenerconsulting.com/virtufin/helm" "helm repo" _blank
click deploylocal "https://git.haenerconsulting.com/virtufin/deploy-local" "deploy-local repo" _blank
click dockercompose "https://git.haenerconsulting.com/virtufin/docker-compose" "docker-compose repo" _blank
click benchmarks "https://benchmarks.docs.virtufin.com" "benchmark reports" _blank
click docs "https://docs.virtufin.com" "docs site (this site)" _blank
Virtufin repos
| Repo | What it is | Docs site |
|---|---|---|
| virtufin/docs | This site. The central hub — platform overview, concepts, architecture, and this ecosystem map. | docs.virtufin.com |
| virtufin/common | Shared infrastructure: cross-build Docker image, the canonical versions.env convention, shared Directory.Packages.props patterns, and the shared docs assets (mkdocs-base.yml, stylesheets/common.css, javascripts/mermaid-zoom.js) that every docs site pulls in at build time. Hosts the reusable CI workflows (.github/workflows), among them docs-common.yaml, which builds and publishes each repo's docs site. |
(no docs site) |
| virtufin/openspec | The platform's normative specifications: cross-cutting rules (API-mediated pub/sub, CloudEvent envelope), per-service specs (API gateway, worker management, WebSocket feed, multi-SDK), and operational specs (deployment, CI/CD). Scenario-driven (WHEN/THEN/AND) format. | specs.docs.virtufin.com |
| virtufin/lib | The .NET 10 library layer: Virtufin.Core (EAV framework, contract traits, DecimalAmount), Virtufin.Base (concrete types: Currency, Cash, Position, Metronome<T>), Virtufin.Data (Variant, FlatBuffers, NATS / WebSocket IObservable<T>), Virtufin.Naming (the naming library for topics and state keys), Virtufin.Util (time, formatting). The "core" the rest of the platform is built on. |
lib.docs.virtufin.com |
| virtufin/api | The API gateway. The single mediator through which services talk to Dapr (pub/sub, state). Hosts Gateway.InvokeJson, MethodSchema and the aggregated gRPC reflection, and builds the client libraries: Virtufin.Api.Client (C#), virtufin-api (Python), @virtufin/api (TypeScript). |
api.docs.virtufin.com |
| virtufin/workmanager | The WorkManager (the worker catalog and router), the WorkManager Runtime (hosts every worker in a per-engine Dapr actor: DotNetDllEngine, NativeDllEngine, PythonEngine, CSharpSourceEngine) and the worker host contract (Virtufin.Worker.Host: IWorker, IWorkerContext, WorkerEventRules, the native/AOT protocol — host-shared and version-locked to the runtime), the worker-management client (Virtufin.WorkManager.Client: IWorkManagerClient, WorkerSpec, GatewayWorkManagerClient) and the in-process loaders (Virtufin.WorkManager.Engines.Local). |
workmanager.docs.virtufin.com |
| virtufin/worker-devkit | The cross-domain worker authoring toolkit (Virtufin.Worker.DevKit), generic: no domain code (no business names, no domain envelope attributes): the ICodec content-type codec registry, WorkerBase<,>, BehaviorWorkerBase (Virtufin.Behavior.DevKit), LocalWorkManager (an IWorkManagerClient in-process) with LocalVirtufinApi, the CloudEvent binding and generic envelope helpers (correlation, times), config resolution, pacing and the state-store contract. Every devkit and worker builds on it; it is a worker-private dependency, so it can move independently of the runtime. |
worker-devkit.docs.virtufin.com |
| virtufin/domain-devkit | The domain basics every domain devkit builds on (Virtufin.Domain.DevKit, PyPI virtufin-domain-devkit, npm @virtufin/domain-devkit): the domain envelope (scenarioid, runid, exchange, clocktype, the market/portfolio/strategy worlds, marketuniverse) and the virtufin.worlds names (worlds, the scenario scope, the scenario, world and strategy registries). |
domain-devkit.docs.virtufin.com |
| virtufin/websocketmanager | Archived (retired 2026-10-31). The WebSocketManager service, the former proxy for external WebSocket connections (Binance, Alpaca, etc.). Replaced by the WebSocketFeed worker in general-workers, one worker per connection (workmanager#103); it is no longer deployed (helm chart 0.5.0) and its client packages are no longer published. |
(no docs site) |
| virtufin/strategy-devkit | The strategy development kit: the IDecide coalgebra bridge and reusable pieces that turn a strategy into a WorkManager worker. Producer half of the decide/execute loop. Its Virtufin.Trading.Contracts (and PyPI virtufin-trading-contracts) owns the virtufin.trading names (a scenario's orders and trades). |
strategy-devkit.docs.virtufin.com |
| virtufin/execution-devkit | The execution development kit: bridges an IExecutor into a WorkManager worker. Consumer half of the decide/execute loop. |
execution-devkit.docs.virtufin.com |
| virtufin/indicator-devkit | Deploys any IIndicator<TSelf, TSample, TValue> as a standalone WorkManager worker. |
indicator-devkit.docs.virtufin.com |
| virtufin/market-data-devkit | Builds world-scoped market-data workers (MarketDataWorkerBase: the market-data envelope, the exchange's event time) and owns the market-data contracts, starting with the OHLCV candle. |
market-data-devkit.docs.virtufin.com |
| virtufin/portfolio-devkit | Builds world-scoped portfolio workers (PortfolioWorkerBase: the portfolio envelope, the venue's event time) and owns the virtufin.portfolio names and contracts: account snapshot, balance, holding, ledger entry, open order; and the virtufin.positions names of a scenario's positions, P&L and risk (sc.<S>.pnl.book). Observe only. |
portfolio-devkit.docs.virtufin.com |
| virtufin/strategy-workers | Deployable strategy workers built on the IDecide coalgebra and strategy-devkit (e.g. moving-average crossover, C# + Python variants). |
strategy-workers.docs.virtufin.com |
| virtufin/execution-workers | Deployable executor workers (Simulated / Shadow / Live) built on execution-devkit. Consumer half of the decide/execute loop's deployed fleet. |
execution-workers.docs.virtufin.com |
| virtufin/indicator-workers | Deployable indicator workers built on indicator-devkit (SimpleMovingAverage, AbsoluteReturn, RelativeReturn, LogReturn, ShannonEntropy): fold closed candles into scenario-scoped indicator values. |
indicator-workers.docs.virtufin.com |
| virtufin/market-data-workers | Deployable market-data workers built on market-data-devkit (a Binance order-book maintainer, Binance candles) — ingest and maintain market data rather than participating in the decide/execute loop directly. |
market-data-workers.docs.virtufin.com |
| virtufin/portfolio-workers | Deployable portfolio workers built on portfolio-devkit: ingest the venue-side view of user portfolios (balances, holdings, ledger, open orders). BinancePortfolio (account snapshots and the user data stream) and BinancePositionReconciler (position recovery: sets a degraded strategy's holding from the venue's, only when it is the sole trader of the asset and never above its last known holding), both on the testnet, and PnL (a scenario's per-symbol P&L and spot exposure from its fills and the order-book mids, with display-only limits); Alpaca planned. They never act on a venue: orders belong to the executors. |
portfolio-workers.docs.virtufin.com |
| virtufin/general-workers | Cross-domain workers: HttpGet (the canonical example), Hello, GetTime, and the WebSocketFeed (one upstream WebSocket connection as a worker: login, subscriptions, routed frames, commands through InvokeWorkerCommand; built on Virtufin.WebSocket.DevKit). Its docs cover the build pipeline (managed / native / both), packaging and the runtime arch check. |
general-workers.docs.virtufin.com |
| virtufin/examples | Worked examples — dotnet, Python and TypeScript. Verso notebooks take each devkit end to end (write a worker, test it, publish it, deploy it on demo, observe it) and chain the published engines (devkit-pipeline.verso); Python and TypeScript clients call the platform APIs through the gateway. Every example picks its API by a context name near its top ("demo" by default, from contexts.toml). For an AOT-portable worker project, see HttpGet in virtufin/general-workers. |
examples.docs.virtufin.com |
| virtufin/service | Archived. Its API-key client interceptor and IInstanceIdProvider moved into Virtufin.Api.Client 0.14.0 (with AddVirtufinApi); WorkManager 0.29.1 and WebSocketManager 0.9.1 no longer reference it. Ownership of connections and workers is Dapr actors, not this library. |
(no docs site) |
| virtufin/tui | Operator dashboard: a Textual-based Python terminal UI that connects to a api endpoint. |
tui.docs.virtufin.com |
| virtufin/app | The operator web app (app.virtufin.com): workers, connections, pages and navigation as data; follows the operator-clients and web-app specs; calls the WorkManager with typed protobuf through Gateway.Invoke. Deployed by k3s-common's virtufin_app role. |
app.docs.virtufin.com |
| virtufin/site | The public landing page at www.virtufin.com — a single hand-written static page, no framework or build step. | (this is the site itself) |
| virtufin/helm | The Helm chart that deploys the Virtufin microservices platform with Dapr sidecars on Kubernetes. | (no docs site) |
| virtufin/deploy-local | Runs the Virtufin backend services natively via dapr run for local dev — no Docker containers for the services themselves, only Dapr-managed sidecars. |
(no docs site) |
| virtufin/docker-compose | Archived in favour of deploy-local. It deployed the platform locally via Docker Compose. |
(no docs site) |
| virtufin/benchmarks | Results of the WorkManager benchmarks (harness in workmanager/benchmarks, nightly at 02:00 UTC and on demand): one immutable JSON per run, engine and series, a report of the latest run against the rolling median (engine overhead, pipeline, pipeline saturation), and a regression issue that opens on a regression and closes after 3 healthy runs. The site is a generated HTML report, not MkDocs. |
benchmarks.docs.virtufin.com |
How the sites are built
All the docs sites are built with the same toolchain:
- MkDocs Material, configured once in common/docs/mkdocs-base.yml: the theme (indigo palette, dark/light
toggle, search, code annotations), the markdown extensions, and the shared header and footer. Every site's
header shows the repo and a badge with the commit it was built from; the footer shows the build time.
- mkdocs_v1.yml is the canonical config filename (mirroring each service's API version, e.g. v1). It starts
with INHERIT: mkdocs-base.yml and holds only what is specific to the repo: site name and URL, repo, nav, and
the shared common.css / mermaid-zoom assets. A site may override a theme feature list or the markdown
extensions (tui does); lists replace the base's.
- docs-common.yaml in common/.github/workflows/ is the reusable workflow: it fetches the shared templates
and mkdocs-base.yml, fills in the commit and build time, builds, and publishes. Each repo's
.github/workflows/docs.yaml calls it with its own docs_repo and mkdocs_config.
- docs-lint-common.yaml is the reusable lint workflow for docs PRs.
- Hosting: each site is a Cloudflare Pages project, <name>-docs-virtufin-com, served at
<name>.docs.virtufin.com (the CNAME file at the docs root names the domain).
A new docs site needs its domain set up once. The workflow creates and deploys the Pages project, but the
domain needs two records, without which it doesn't resolve (as for indicator-workers and market-data-devkit
until 2026-10-10):
1. a CNAME at DNS Made Easy (zone virtufin.com): <name>.docs → <name>-docs-virtufin-com.pages.dev., TTL 1800;
2. the custom domain <name>.docs.virtufin.com on the Pages project (Cloudflare dashboard or API), which turns
active once the CNAME resolves.
The same theme settings are used across every site so a developer can move between them without visual whiplash.