Skip to main content

Crate polyester

Crate polyester 

Source
Expand description

Official Rust SDK for Polyester APIs.

Built on Connect for Rust and Polyester’s published Protobuf contracts (Buffa + Connect codegen).

§Quick start

use polyester::{Client, Config};
use polyester::types::{Price, Quantity};

#[tokio::main]
async fn main() -> polyester::Result<()> {
    let client = Client::new(Config {
        api_key_id: Some("ak_...".into()),
        api_private_key: Some("...".into()),
        default_account_id: Some("...".into()),
        ..Default::default()
    })?;
    let _ = client.auth.me().await?;
    Ok(())
}

§Qty / price

Order write APIs take types::Price / types::Quantity only:

  • Humans: Price::from_decimal_str("1.5") / Quantity::from_decimal_str("0.01", scale, …)
  • Bots: Price::from_ticks(1_500_000) / Quantity::from_scaled(…)

Floats and bare integers are rejected.

Re-exports§

pub use client::Client;
pub use client::Config;
pub use errors::Error;
pub use errors::Result;
pub use errors::auth_codes;
pub use services::PreparedTradingWithdraw;
pub use services::new_trading_withdraw_idempotency_key;
pub use services::new_trading_withdraw_nonce;
pub use types::AssetAmount;
pub use types::Price;
pub use types::PriceTicks;
pub use types::QtyScaled;
pub use types::Quantity;
pub use types::QuantityDomain;
pub use types::resolve_asset_amount_scaled;
pub use types::resolve_price_ticks;
pub use types::resolve_qty_scaled;
pub use types::resolve_quote_qty_scaled;

Modules§

auth
Ed25519 API-key credentials and request signing.
catalogs
Spot / zipper catalog cache for scale lookups.
chain
On-chain Funding and smart-account helpers.
client
Root Polyester SDK client.
codecs
connect
Generated ConnectRPC service clients and server traits.
errors
SDK error types (parity with Go/Python).
marketoverview
Market overview helpers (Go marketoverview package parity).
models
Owned SDK models. Proto owned messages are also re-exported for escape hatches.
orderbook
Local orderbook helpers (Go orderbook package parity).
proto
Generated Buffa message types (crate::proto for Connect stubs).
realtime
Centrifugo websocket realtime client.
services
Service wrappers over generated Connect clients.
transport
HTTP/Connect transport factory and API-key request signing.
types
user_agent
Stable HTTP User-Agent for Polyester SDK clients.

Constants§

VERSION