GoDark Rust SDK
Encrypted Rust client for the GoDark DEX. Protocol matches gdx-edge and gdx-sequencer: HPKE Base (RFC 9180) over WebSocket binary frames, and one-shot HPKE on REST.
Quickstart
Published crate: cargo add godark. build.rs uses committed src/generated
unless you regenerate (bash scripts/proto_gen.sh).
Layout
src/
lib.rs public re-exports (`GodarkClient`, `GodarkRestClient`, …)
client.rs WebSocket trading client
rest_client.rs REST trading client
config.rs Environment + builder
types.rs domain types
enums.rs order/side/status enums
error.rs
market_data.rs
hpke.rs crate-private crypto
session.rs crate-private WS HPKE session
wire.rs crate-private TradingWsBinaryFrame
transport.rs crate-private WS transport
generated/ committed prost bindings
tests/ mocks + live `#[ignore]` suites
examples/
WebSocket
JSON text frames are control only: login, subscribe/unsubscribe, ping,
logout, get_order_history. Encrypted orders and HPKE setup are binary
TradingWsBinaryFrame (HpkeSetup → HpkeSetupReply → EncryptedOrder /
EncryptedPush).
Login returns conn_id. HPKE info is gdx-hpke/v1\0 ‖ user_uuid ‖ conn_id_be.
Send nonces start at 0 (sequencer last_recv_nonce is unset until the first
request). Wire version = 2.
Pin the sequencer static public key (64 hex):
use ;
let config = builder
.environment
.api_key_id
.api_secret
.passphrase
.hpke_static_public_key_hex
.build?;
| Environment | Default URL |
|---|---|
| Testnet | wss://api.godark-dex.com/ws/v1 |
| Devnet | wss://api.devnet.godark-dex.com/ws/v1 |
| Localnet | ws://127.0.0.1:13300/ws/v1 |
HPKE pins are not baked into the crate. Set .hpke_static_public_key_hex(...)
or GDX_HPKE_STATIC_PUBLIC_KEY.
Balances come from sequencer BalanceUpdateMessage / encrypted
balance_and_position (trading collateral balance_raw).
REST
POST /api/v1/auth/token, then encrypted POST/PATCH/DELETE /api/v1/orders
with JSON { header, encrypted_body, encapped_key, request_id }. Each call is
a fresh HPKE setup (info = gdx-hpke/v1/rest\0 ‖ user_uuid ‖ request_id_be,
conn_id = 0).
Live snapshot reads (same envelope, request_type snake_case in the header):
| Method | Path | request_type |
Reply |
|---|---|---|---|
get_open_orders() |
POST /api/v1/openOrders |
get_open_orders |
open_orders_snapshot |
get_positions() |
POST /api/v1/positions |
get_positions |
positions_snapshot |
get_account() |
POST /api/v1/account |
get_account |
account_margin_update |
Testing
Live tests: GDX_LIVE_EDGE=1 plus API credentials, --ignored.