SDK overview¶
The Aetelier SDK is a Rust workspace of six crates for market-data research on the Aetelier platform:
aetelier-types— the shared data model: trades, order books, timestamps in UTC epoch microseconds, and the wire types the platform speaks.aetelier-connect— venue connectivity: WebSocket clients with reconnect, the worker framework, book reconstruction, and the conformance-certified venue adapters.aetelier-io— columnar persistence: Parquet writers and readers for every datatype, filename conventions, and loss accounting artifacts.aetelier-entrepot— archive access: an S3 reader for venue archives with integrity verification and cost accounting.aetelier-telemetry— metrics and structured telemetry for long-running collectors.aetelier-sdk— the facade crate that re-exports the workspace surface behind one dependency.
The mental model: connect ingests and validates, types carries the rows, io persists them, entrepot replays archives, telemetry watches the whole thing.
Adding the SDK to a project¶
# Cargo.toml
[dependencies]
aetelier-sdk = { git = "https://github.com/aetelierxyz/aetelier-sdk", tag = "v0.1.0" }
The crates are not on crates.io, so the dependency resolves from git.
The tag is mutable; pin rev = "<sha>" for a reproducible build.
What's documented where¶
- API reference — auto-generated from the SDK's
public Rust API by
scripts/cargo_doc_to_md.py. Updated on each docs build that runs against a checkout ofaetelier-sdk. - Backend reference — the wire contract the SDK speaks to. Read this if you're building a non-Rust client or debugging at the protocol level.
- Guides — task-oriented walkthroughs.
Source¶
The crate lives at
aetelierxyz/aetelier-sdk.
File issues against the SDK in that repo; file documentation issues
against this repo (aetelier-webdocs).