ostium-rust-sdk 0.1.0

Rust SDK for interacting with the Ostium trading platform on Arbitrum
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263

---
layout: landing
---

# Ostium Rust SDK

Modern, type-safe Rust SDK for perpetual trading on the Ostium platform. Built with [Alloy](https://alloy.rs/) for Ethereum interactions and designed for production use on Arbitrum.

:::code-group

```rust [Installation]
# Add to Cargo.toml
[dependencies]
ostium-rust-sdk = "0.1.0"
```

```rust [Quick Start]
use ostium_rust_sdk::{OstiumClient, Network};

let client = OstiumClient::new(Network::Testnet).await?;
let price = client.get_price("BTC/USD").await?;
println!("BTC Price: ${}", price.mark_price);
```

```rust [Trading]
use ostium_rust_sdk::{OpenPositionParams, PositionSide};
use rust_decimal_macros::dec;

let params = OpenPositionParams {
    symbol: "BTC/USD".to_string(),
    side: PositionSide::Long,
    size: dec!(0.01),
    leverage: dec!(5.0),
    take_profit: Some(dec!(55000)),
    stop_loss: Some(dec!(45000)),
    slippage_tolerance: dec!(0.01),
};

let tx_hash = client.open_position(params).await?;
```

:::

## Features

<div class="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 gap-6 mt-8">

<div class="feature-card">
  <div class="feature-icon">🦀</div>
  <h3>Pure Rust</h3>
  <p>Type-safe and performant with zero-cost abstractions. Built with modern Rust patterns and async/await support.</p>
</div>

<div class="feature-card">
  <div class="feature-icon">⚡</div>
  <h3>High Performance</h3>
  <p>Optimized for speed with connection pooling, intelligent caching, and efficient memory management.</p>
</div>

<div class="feature-card">
  <div class="feature-icon">🔐</div>
  <h3>Secure by Design</h3>
  <p>Industry-standard security practices with secure key management and transaction validation.</p>
</div>

<div class="feature-card">
  <div class="feature-icon">🌐</div>
  <h3>Multi-Network</h3>
  <p>Supports both Arbitrum mainnet and testnet with easy network switching and configuration.</p>
</div>

<div class="feature-card">
  <div class="feature-icon">📊</div>
  <h3>Complete Trading API</h3>
  <p>Full perpetual trading functionality including positions, orders, market data, and risk management.</p>
</div>

<div class="feature-card">
  <div class="feature-icon">🛡️</div>
  <h3>Error Handling</h3>
  <p>Comprehensive error types with detailed error recovery and debugging information.</p>
</div>

</div>

## Why Ostium?

**Decentralized Perpetual Trading** - Trade crypto pairs with up to 100x leverage on a decentralized platform built on Arbitrum.

- **Low Fees** - Competitive trading fees powered by Arbitrum's efficiency
- **Deep Liquidity** - Access to institutional-grade liquidity pools
- **Advanced Features** - Take profit, stop loss, and sophisticated order types
- **Transparent** - All trades executed on-chain with full transparency

## Getting Started

<div class="steps">

### 1. Install the SDK

Add the Ostium Rust SDK to your `Cargo.toml`:

```toml
[dependencies]
ostium-rust-sdk = "0.1.0"
tokio = { version = "1.0", features = ["full"] }
rust_decimal = "1.0"
```

### 2. Create a Client

```rust
use ostium_rust_sdk::{OstiumClient, Network};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Create a read-only client
    let client = OstiumClient::new(Network::Testnet).await?;
    
    // Or create a client with trading capabilities
    let client = OstiumClient::builder(Network::Testnet)
        .with_private_key("0x...")?
        .build()
        .await?;
    
    Ok(())
}
```

### 3. Start Trading

```rust
// Check your balance
let balance = client.get_balance(None).await?;
println!("Balance: ${}", balance.total);

// Get market price
let price = client.get_price("BTC/USD").await?;
println!("BTC/USD: ${}", price.mark_price);

// Open a position
let params = OpenPositionParams {
    symbol: "BTC/USD".to_string(),
    side: PositionSide::Long,
    size: dec!(0.01),
    leverage: dec!(5.0),
    take_profit: Some(dec!(55000)),
    stop_loss: Some(dec!(45000)),
    slippage_tolerance: dec!(0.01),
};

let tx_hash = client.open_position(params).await?;
println!("Position opened: {}", tx_hash);
```

</div>

## What's Next?

<div class="next-steps">

**New to the SDK?** Start with our [Installation Guide](/getting-started/installation) and [Quick Start Tutorial](/getting-started/quickstart).

**Ready to Trade?** Follow our [First Trade Tutorial](/getting-started/first-trade) for a complete walkthrough.

**Building an App?** Check out our [Integration Patterns](/examples/integration-patterns) and [Trading Bot Example](/examples/trading-bot).

**Need Help?** Visit our [Troubleshooting Guide](/troubleshooting/common-issues) or [join our Discord](https://discord.gg/ostium).

</div>

## Community & Support

- **📖 Documentation** - Comprehensive guides and API reference
- **🐛 Issues** - Report bugs on [GitHub Issues](https://github.com/ranger-finance/ostium-rust-sdk/issues)  
- **💬 Discord** - Join our [Discord community](https://discord.gg/ostium)
- **🐦 Twitter** - Follow [@OstiumProtocol](https://twitter.com/ostiumprotocol)

---

<div class="footer-cta">

**Ready to start building?** [Get started now →](/getting-started/installation)

</div>

<style>
.feature-card {
  background: var(--vocs-color-surface);
  border: 1px solid var(--vocs-color-border);
  border-radius: 8px;
  padding: 24px;
  transition: all 0.2s ease;
}

.feature-card:hover {
  border-color: var(--vocs-color-accent);
  transform: translateY(-2px);
}

.feature-icon {
  font-size: 2rem;
  margin-bottom: 16px;
}

.feature-card h3 {
  margin: 0 0 12px 0;
  color: var(--vocs-color-text-primary);
}

.feature-card p {
  margin: 0;
  color: var(--vocs-color-text-secondary);
  line-height: 1.5;
}

.steps {
  counter-reset: step;
}

.steps h3::before {
  counter-increment: step;
  content: counter(step);
  background: var(--vocs-color-accent);
  color: white;
  font-size: 0.875rem;
  font-weight: 600;
  padding: 4px 8px;
  border-radius: 9999px;
  margin-right: 12px;
}

.next-steps {
  background: var(--vocs-color-surface-secondary);
  border: 1px solid var(--vocs-color-border);
  border-radius: 8px;
  padding: 24px;
  margin: 32px 0;
}

.footer-cta {
  text-align: center;
  padding: 32px 0;
  border-top: 1px solid var(--vocs-color-border);
  margin-top: 64px;
}

.footer-cta a {
  background: var(--vocs-color-accent);
  color: white;
  padding: 12px 24px;
  border-radius: 6px;
  text-decoration: none;
  font-weight: 600;
  display: inline-block;
  transition: all 0.2s ease;
}

.footer-cta a:hover {
  transform: translateY(-1px);
  box-shadow: 0 4px 12px rgba(0, 0, 0, 0.15);
}
</style>