Skip to main content

Wickra Synth — deterministic synthetic market microstructure: OHLCV, order book, trades and funding from a single seed, byte-identical across ten languages

Built on Wickra Status CI CodeQL codecov GitHub release crates.io PyPI npm NuGet Maven Central Go module R-universe License: MIT OR Apache-2.0 OpenSSF Scorecard OpenSSF Best Practices Build provenance Docs Verified across 10 languages


Deterministic synthetic market microstructure — OHLCV, order book, trades and funding from a single seed, byte-identical across ten languages.

▶ Live demos: the backtester compiled to WebAssembly, an equity curve building bar by bar — backtest-live.wickra.org; one StrategySpec side by side in Python, Rust, JS and Go — playground.wickra.org; all 514 indicators of the core over a real Binance feed — live.wickra.org. Zero backend, all of them.

Part of the Wickra ecosystem: the same data-driven core and ten-language binding surface also power wickra-exchange, wickra-backtest, wickra-terminal and 20 more — see the full list.

Wickra Synth is one data-driven core, wickra-synth-core: a serde GenSpec describes a market regime, a fixed portable PRNG (SplitMix64 seeding xoshiro256++) drives it, and the core emits OHLCV candles plus order-book snapshots, trades and funding samples — realistic synthetic microstructure for tests, training and demos. Because the RNG lives only in the Rust core and is portable-deterministic, a given seed yields the byte-for-byte identical stream on every platform and through every language binding. The output mirrors the JSON shapes of the rest of the ecosystem, so it drops straight into backtests, screeners and RL environments.

Because the spec is data, not code, the exact same generation crosses the C ABI and WASM unchanged. The core is exposed as a JSON-over-C-ABI data API (Synth::command_json) in Rust, Python, Node.js, WASM, C, C++, C#, Go, Java and R, so a developer in any language draws the same synthetic market.

Status

0.1.3 — the current release. The core, the reference CLI, the ten-language binding surface, the golden corpus and the full CI matrix are in place; the generation model and command protocol are pinned by golden tests.

Documentation

  • ARCHITECTURE.md — workspace layout and the core-only-randomness design.
  • GENSPEC.md — the input specification, its fields and every validation rule.
  • PROTOCOL.md — the command_json boundary all ten bindings forward to.
  • REGIMES.md — the trend / range / crash / vol price-path formulas.
  • MICROSTRUCTURE.md — order book, trades and funding.
  • DETERMINISM.md — the PRNG and the fixed draw-order contract.
  • Cookbook.md — practical recipes.

Quickstart

cargo install wickra-synth
wickra-synth --seed 42 --bars 20 --format json

Twenty bars of OHLCV, an order book, trades and funding, from nothing but the number 42 — and the same twenty bars on every platform and in every one of the ten languages below. The spec that shaped them is JSON, so the same seed and spec reproduce the same market from any binding.

Use in any language

Every binding forwards the same command_json string to the Rust core, so all ten draw byte-identical synthetic markets for a given seed.

from wickra_synth import Synth
import json

synth = Synth('{"seed":42,"bars":20,"start_price":100.0,'
              '"regimes":[{"kind":"trend","len":20,"drift":0.002,"vol":0.01}],'
              '"microstructure":{"book_depth":5,"spread_bps":4.0,"trade_rate":8.0}}')
out = json.loads(synth.command('{"cmd":"generate"}'))
print(len(out["candles"]))  # 20

Runnable examples for all ten languages — each printing the same first three candles — live in examples/.

Project layout

crates/synth-core     the engine: GenSpec, the PRNG, the walk, the microstructure
crates/synth-cli      wickra-synth, the reference consumer
crates/synth-bench    criterion benchmarks
bindings/c            the C ABI hub (cdylib + staticlib) plus the C++ hull
bindings/python       PyO3 / maturin, abi3-py39
bindings/node         napi-rs, per-platform npm packages
bindings/wasm         wasm-bindgen
bindings/csharp       P/Invoke over the hub
bindings/go           cgo over the hub
bindings/java         Foreign Function & Memory API over the hub
bindings/r            .Call glue over the hub
golden/               specs + blessed outputs, the cross-language contract
examples/             one runnable example per language
fuzz/                 cargo-fuzz targets for parse, generate, PRNG and FFI
docs/                 the deep dives; see docs/README.md

Six of the ten reaches go through one C ABI (bindings/c), which is why there is exactly one place a marshalling bug can live rather than six.

Building everything from source

The core and the CLI need only cargo:

cargo build --workspace
cargo test  --workspace

The bindings each need their own toolchain, and the six that go through the C ABI need it built first:

cargo build --release -p wickra-synth-c          # the hub the six link against

cd bindings/python && maturin develop --release  # Python
cd bindings/node   && npm install && npx napi build --platform --release
cd bindings/wasm   && wasm-pack build --target nodejs
dotnet build bindings/csharp/WickraSynth -c Release
mvn -f bindings/java package
R CMD INSTALL bindings/r                         # WKSYNTH_INC/WKSYNTH_LIB, see below
cmake -S examples/c -B examples/c/build && cmake --build examples/c/build

The R binding downloads a matching prebuilt C ABI by default. To build it against the one in your tree instead, set WKSYNTH_INC to bindings/c/include and WKSYNTH_LIB to target/release.

Testing

cargo test --workspace --all-features
cargo test --workspace --no-default-features

Beyond the unit tests, four suites are worth knowing about:

  • Golden — every binding replays golden/specs and must reproduce golden/expected byte for byte. That is the cross-language guarantee, and it is checked in all ten reaches, not asserted in the README.
  • RNG vectors — fixed SplitMix64 and xoshiro256++ reference values. If these move, every seed in the world moves with them.
  • Stream equals batch — the reassembled event stream equals the batch output, so the two paths cannot drift apart.
  • Property tests — random specs stay finite and well formed, and the same seed gives the same bytes.

Per-binding commands are in CONTRIBUTING.md; the scripts/check_*.py family holds the version, licence, link and binding-surface invariants that no compiler checks.

Requirements

The core needs nothing but a Rust toolchain — no system libraries, no BLAS, no Python at build time. Each binding adds only its own runtime:

Reach Floor Where it is declared
Rust (workspace) 1.86 Cargo.toml, rust-version
Rust (Node binding build) 1.88 bindings/node/Cargo.toml — napi-build needs it
Python 3.9 bindings/python/pyproject.toml, requires-python (abi3)
Node.js 22 bindings/node/package.json, engines.node
.NET 8.0 bindings/csharp/WickraSynth/WickraSynth.csproj
Go 1.23 bindings/go/go.mod
Java 22 bindings/java/pom.xml — the Foreign Function & Memory API
R 4.1 bindings/r/DESCRIPTION, Depends

scripts/check_version_sync.py holds these numbers against the manifests, so a floor that moves in one place and not the other is a failing check rather than a support question.

Benchmarks

Per-generation throughput is tracked in BENCHMARKS.md and measured by the synth-bench crate (cargo bench -p synth-bench). A shallow book with light trade flow generates roughly 4.3 million candles per second; the microstructure, not the price walk, is what the time goes on.

Ecosystem

Wickra Synth is one repository in a family that shares a core and a ten-language binding surface:

  • wickra — 514 streaming indicators, the core everything else is built on.
  • wickra-backtest — a streaming-native backtester where backtest and live are the same code path.
  • wickra-screener — scan thousands of symbols against data-driven conditions.
  • wickra-exchange — one typed API over the ten largest crypto exchanges.
  • wickra-terminal — a streaming trading terminal over the same core.

Synth is the one that needs no market data at all: it is where the others get a reproducible market to test against. The full list is at github.com/wickra-lib.

Contributing

See CONTRIBUTING.md.

Security

See SECURITY.md and THREAT_MODEL.md. Note the PRNG is a fast non-cryptographic generator for reproducible simulation — it is not suitable for any security or cryptographic purpose.

License

Licensed under either of

at your option. Use it, fork it, modify it, redistribute it — commercially or not — file issues, send pull requests; all welcome.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Disclaimer

wickra-synth generates synthetic market data for testing, training and demonstration. It is not real market data and is not financial advice; it comes with no warranty.


GitHub stars GitHub forks GitHub issues

Built on Wickra. If it saved you time, the cheapest way to say thanks is to ⭐ the repo.

wickra-synth star history

Metadata

Release files for wickra-synth 0.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for wickra-synth 0.1.3
File Size Uploaded
wickra_synth-0.1.3.tar.gz 62.0 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for wickra-synth 0.1.3
File
wickra_synth-0.1.3-cp39-abi3-win_arm64.whl CPython 3.9 abi3 Windows ARM64 Details
wickra_synth-0.1.3-cp39-abi3-win_amd64.whl CPython 3.9 abi3 Windows x86-64 Details
wickra_synth-0.1.3-cp39-abi3-musllinux_1_2_x86_64.whl CPython 3.9 abi3 Linux musl 1.2+ x86-64 Details
wickra_synth-0.1.3-cp39-abi3-musllinux_1_2_aarch64.whl CPython 3.9 abi3 Linux musl 1.2+ ARM64 Details
wickra_synth-0.1.3-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl CPython 3.9 abi3 Linux glibc 2.17+ x86-64 Details
wickra_synth-0.1.3-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl CPython 3.9 abi3 Linux glibc 2.17+ ARM64 Details
wickra_synth-0.1.3-cp39-abi3-macosx_11_0_arm64.whl CPython 3.9 abi3 macOS 11.0+ ARM64 Details
wickra_synth-0.1.3-cp39-abi3-macosx_10_12_x86_64.whl CPython 3.9 abi3 macOS 10.12+ x86-64 Details

Total release size: 2.5 MB

Release files / wickra_synth-0.1.3.tar.gz

Download URL wickra_synth-0.1.3.tar.gz
Size 62.0 kB
Tags Source
SHA-256 checksum
How to use checksums
6f2f14a77842d06c397a7107060eba0257447cd553dabd3da7851b15164f2baa
BLAKE2b-256 checksum
How to use checksums
493e24744a9652e244e96f0862c73f83640749de95d78a9883ce87e94f35a1e8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.15.0

Release files / wickra_synth-0.1.3-cp39-abi3-win_arm64.whl

Download URL wickra_synth-0.1.3-cp39-abi3-win_arm64.whl
Size 180.1 kB
Tags CPython 3.9 Windows ARM64 abi3
SHA-256 checksum
How to use checksums
6187504036ab9ad522d59fd5998dcf938e57f88542d50189fe5f7ac678c653e0
BLAKE2b-256 checksum
How to use checksums
d4294a9615407c4650ed6508cc97f1cafed14eca39a5613cc6242218fc992f20
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.15.0

Release files / wickra_synth-0.1.3-cp39-abi3-win_amd64.whl

Download URL wickra_synth-0.1.3-cp39-abi3-win_amd64.whl
Size 191.3 kB
Tags CPython 3.9 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
a822ce557fd0d60c3d45dd8bceeffe10e05991efcf29112266edb3a84ededf80
BLAKE2b-256 checksum
How to use checksums
284ca7c784d40fc44c32064ee99ac9b264cc5402365da905b1a1e00fc363b2eb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.15.0

Release files / wickra_synth-0.1.3-cp39-abi3-musllinux_1_2_x86_64.whl

Download URL wickra_synth-0.1.3-cp39-abi3-musllinux_1_2_x86_64.whl
Size 502.9 kB
Tags CPython 3.9 Linux musl 1.2+ x86-64 abi3
SHA-256 checksum
How to use checksums
7d1636e15ecfac593dd5d6484e2529099f83b9c41f5609951de97a0d4e717d92
BLAKE2b-256 checksum
How to use checksums
baa9d6c2ccd50d84f982b8eba094d1a066ab0bf97526e273250a1af07189d06c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.15.0

Release files / wickra_synth-0.1.3-cp39-abi3-musllinux_1_2_aarch64.whl

Download URL wickra_synth-0.1.3-cp39-abi3-musllinux_1_2_aarch64.whl
Size 452.5 kB
Tags CPython 3.9 Linux musl 1.2+ ARM64 abi3
SHA-256 checksum
How to use checksums
42ad97397f9bc41d66edb3afa1addda167c2db512a1ca634cfb862c111f45665
BLAKE2b-256 checksum
How to use checksums
51c9af890eb2d256c7154d12193604dfd9c56ef2f980b550882a13a32a8679ee
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.15.0

Release files / wickra_synth-0.1.3-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL wickra_synth-0.1.3-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 290.1 kB
Tags CPython 3.9 Linux glibc 2.17+ x86-64 abi3
SHA-256 checksum
How to use checksums
b20be129acba92b2e76b38f3449084c0289bb84c686aac522f2334131e9327f8
BLAKE2b-256 checksum
How to use checksums
cb9bb35bd371abb468451eedbbf3f020a31f51ebee5633980610a3037bf5344c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.15.0

Release files / wickra_synth-0.1.3-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl

Download URL wickra_synth-0.1.3-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Size 273.7 kB
Tags CPython 3.9 Linux glibc 2.17+ ARM64 abi3
SHA-256 checksum
How to use checksums
92ac3d56789291d30279462b61e6ae7989136043bf37e76349ed8d665d0dd9b3
BLAKE2b-256 checksum
How to use checksums
0e8b408d4f047ef37637ceda58520b1704b6f3ab70b90b71eb52ca7424cd6599
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.15.0

Release files / wickra_synth-0.1.3-cp39-abi3-macosx_11_0_arm64.whl

Download URL wickra_synth-0.1.3-cp39-abi3-macosx_11_0_arm64.whl
Size 256.7 kB
Tags CPython 3.9 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
22aa032028296f2b8bafaf836f6b4de5f3cc3281c38090c1519639ed2119269b
BLAKE2b-256 checksum
How to use checksums
084b8484104be57cdc51acc0bc752a13f469ef9d764f1465e0c28bc46e2d81ea
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.15.0

Release files / wickra_synth-0.1.3-cp39-abi3-macosx_10_12_x86_64.whl

Download URL wickra_synth-0.1.3-cp39-abi3-macosx_10_12_x86_64.whl
Size 276.1 kB
Tags CPython 3.9 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
c440eb132f6f1689cee6f2acf13cc6003599dc530c118676fac8135ddf6aca67
BLAKE2b-256 checksum
How to use checksums
e198387c68896c67c16ff929dc80e82e84e621fe3564f2cedc470eed3a013c1c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.15.0

Release history Release notifications | RSS feed

0.2.0

9 release files

0.1.4

9 release files

This release

0.1.3 This release

9 release files

0.1.2

9 release files

0.1.1

9 release files

0.1.0

9 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page