Aetelier SDK¶
Research Infrastructure for Distributed Markets. A Rust workspace for collecting microstructure data from cryptocurrency exchanges and replaying it deterministically.
Start here¶
-
Getting started
From
cargo newto a Parquet file of live Bybit data with one TOML manifest and a small runner. -
Architecture
The cross-crate data flow, from WebSocket frames to per-datatype Parquet, with diagrams.
-
Tutorials
Two end-to-end walkthroughs: single-exchange persistence and multi-exchange sync.
-
Research
Dated, authored methodology notes — the reasoning behind the numbers, with reproducible code.
Where things live¶
| What | Where |
|---|---|
| SDK source code | aetelierxyz/aetelier-sdk — Cargo workspace (install via git dependency) |
| These docs | aetelierxyz/aetelier-webdocs — Markdown rendered by MkDocs Material |
| This site (live) | aetelier.xyz/docs/ — served by an nginx container |
| Per-crate API references | API reference on this site, generated from the SDK source |
The docs are intentionally not in the SDK repo so the SDK can stay a focused Rust workspace. Documentation references the SDK via links and auto-extracted API skeletons (regenerated against a local SDK checkout).
Workspace shape¶
These docs cover the six crates of the aetelier-sdk workspace,
which install as git dependencies. aetelier-agent is a separate
repository, not a workspace member.
| Crate | What it is |
|---|---|
aetelier-types |
Canonical schema (orderbook, trades, snapshots, exchange enums) |
aetelier-connect |
Exchange WebSocket clients, workers, synchronizers, output sinks |
aetelier-io |
Parquet / CSV / JSON persistence |
aetelier-telemetry |
OpenTelemetry instrumentation |
aetelier-entrepot |
Object-store transport: signed S3 access, listing, retrieval, archive codecs |
aetelier-sdk |
Facade crate re-exporting the workspace surface behind one dependency |
The Architecture page walks how they fit together.
Quick links¶
- Research — methodology notes from the lab (full articles on the Aetelier blog; reference index here)
- Dataset catalog — collected microstructure data + schema
- Platform API — the gRPC contract and JWT handshake remote agents use
- About this site — scope, contribution, versioning
- GitHub: aetelier-sdk
- GitHub: aetelier-webdocs