Installation

Install the SDK from crates.io, then verify a public devnet request.

Install the package

[dependencies]
polyester-sdk = "0.1.0-alpha.30"
tokio = { version = "1", features = ["full"] }

Private git pins remain supported when you need a specific commit:

polyester-sdk = { git = "https://github.com/Fabric-Labs/polyester-sdk-rust", tag = "v0.1.0a30" }

The package is named polyester-sdk, but its library target is named polyester. Code therefore imports it with use polyester::..., exactly as the examples show. No Cargo rename is required.

MSRV: Rust 1.88+. Realtime and on-chain Funding helpers are always included. Pin Connect/buffa 0.8.x as required by the crate.

crates.io: polyester-sdk. Source (access required): Fabric-Labs/polyester-sdk-rust.

Default endpoints

With no override, the client targets Polyester devnet:

Override with Config fields, or (scripts only) POLYESTER_API_URL / POLYESTER_WS_URL via Client::from_env().

Verify the install

Public market data needs no credentials:

use polyester::{Client, Config};

let client = Client::new(Config::default())?; // public market data only

use polyester::services::ListMarketOverviewOptions;

let overview = client.market_overview.list(ListMarketOverviewOptions {
    limit: Some(5),
    ..Default::default()
}).await?;
for market in overview.markets {
    println!("{} {:?}", market.symbol, market.last_price.as_ref().map(|p| p.as_ticks()));
}

If that prints a few markets, you are connected. Next: Quickstart.

Contributor live harness (strict)

CI runs unit, compile-fail, strict-harness, and deterministic local HTTP/WebSocket hardening tests. Live integration under tests/integration/ (and the a7_strict_live harness that shells out to it) remains a separate credentialed release gate. Those paths are excluded from the crates.io package — run them from a git checkout of this repository, not from a crates.io download.

cargo test --lib
cargo test --test integration -- --test-threads=1

Public smoke needs no keys (soft-skips when offline). Credentialed runs need POLYESTER_API_KEY_ID / POLYESTER_API_PRIVATE_KEY (usually POLYESTER_ACCOUNT_ID). Optional gates: POLYESTER_TEST_MUTATION=1, POLYESTER_TEST_FUNDED=1. Set POLYESTER_TEST_STRICT_LIVE=1 for release certification so any skip: path fails instead of reporting green.

Related Topics