coinbase-advanced 1.0.0

A Rust client library for the Coinbase Advanced Trade API
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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
//! Ergonomic order builder APIs.
//!
//! These builders provide a more convenient way to construct orders
//! compared to manually creating `CreateOrderRequest` objects.

use crate::client::RestClient;
use crate::error::{Error, Result};
use crate::models::{CreateOrderRequest, CreateOrderResponse, OrderConfiguration, OrderSide, StopDirection};

/// Builder for market orders.
pub struct MarketOrderBuilder<'a> {
    client: &'a RestClient,
    product_id: Option<String>,
    side: Option<OrderSide>,
    quote_size: Option<String>,
    base_size: Option<String>,
    client_order_id: Option<String>,
}

impl<'a> MarketOrderBuilder<'a> {
    /// Create a new market order builder.
    pub(crate) fn new(client: &'a RestClient) -> Self {
        Self {
            client,
            product_id: None,
            side: None,
            quote_size: None,
            base_size: None,
            client_order_id: None,
        }
    }

    /// Set the product ID.
    pub fn product_id(mut self, product_id: impl Into<String>) -> Self {
        self.product_id = Some(product_id.into());
        self
    }

    /// Set as a buy order.
    pub fn buy(mut self, product_id: impl Into<String>) -> Self {
        self.product_id = Some(product_id.into());
        self.side = Some(OrderSide::Buy);
        self
    }

    /// Set as a sell order.
    pub fn sell(mut self, product_id: impl Into<String>) -> Self {
        self.product_id = Some(product_id.into());
        self.side = Some(OrderSide::Sell);
        self
    }

    /// Set the quote size (amount in quote currency, e.g., USD).
    pub fn quote_size(mut self, quote_size: impl Into<String>) -> Self {
        self.quote_size = Some(quote_size.into());
        self
    }

    /// Set the base size (amount in base currency, e.g., BTC).
    pub fn base_size(mut self, base_size: impl Into<String>) -> Self {
        self.base_size = Some(base_size.into());
        self
    }

    /// Set a custom client order ID.
    pub fn client_order_id(mut self, client_order_id: impl Into<String>) -> Self {
        self.client_order_id = Some(client_order_id.into());
        self
    }

    /// Build and send the order.
    pub async fn send(self) -> Result<CreateOrderResponse> {
        let product_id = self.product_id
            .ok_or_else(|| Error::request("product_id is required"))?;
        let side = self.side
            .ok_or_else(|| Error::request("side is required (use .buy() or .sell())"))?;

        let config = if let Some(quote_size) = self.quote_size {
            OrderConfiguration::market_buy_quote(quote_size)
        } else if let Some(base_size) = self.base_size {
            if side == OrderSide::Buy {
                OrderConfiguration::market_buy_base(base_size)
            } else {
                OrderConfiguration::market_sell(base_size)
            }
        } else {
            return Err(Error::request("either quote_size or base_size is required"));
        };

        let client_order_id = self.client_order_id
            .unwrap_or_else(uuid_v4);

        let request = CreateOrderRequest::new(client_order_id, product_id, side, config);
        self.client.orders().create(request).await
    }
}

/// Builder for limit GTC (good-til-cancelled) orders.
pub struct LimitOrderGtcBuilder<'a> {
    client: &'a RestClient,
    product_id: Option<String>,
    side: Option<OrderSide>,
    base_size: Option<String>,
    limit_price: Option<String>,
    post_only: bool,
    client_order_id: Option<String>,
}

impl<'a> LimitOrderGtcBuilder<'a> {
    /// Create a new limit order GTC builder.
    pub(crate) fn new(client: &'a RestClient) -> Self {
        Self {
            client,
            product_id: None,
            side: None,
            base_size: None,
            limit_price: None,
            post_only: false,
            client_order_id: None,
        }
    }

    /// Set as a buy order.
    pub fn buy(mut self, product_id: impl Into<String>) -> Self {
        self.product_id = Some(product_id.into());
        self.side = Some(OrderSide::Buy);
        self
    }

    /// Set as a sell order.
    pub fn sell(mut self, product_id: impl Into<String>) -> Self {
        self.product_id = Some(product_id.into());
        self.side = Some(OrderSide::Sell);
        self
    }

    /// Set the base size.
    pub fn base_size(mut self, base_size: impl Into<String>) -> Self {
        self.base_size = Some(base_size.into());
        self
    }

    /// Set the limit price.
    pub fn limit_price(mut self, limit_price: impl Into<String>) -> Self {
        self.limit_price = Some(limit_price.into());
        self
    }

    /// Set post-only mode (only add liquidity).
    pub fn post_only(mut self, post_only: bool) -> Self {
        self.post_only = post_only;
        self
    }

    /// Set a custom client order ID.
    pub fn client_order_id(mut self, client_order_id: impl Into<String>) -> Self {
        self.client_order_id = Some(client_order_id.into());
        self
    }

    /// Build and send the order.
    pub async fn send(self) -> Result<CreateOrderResponse> {
        let product_id = self.product_id
            .ok_or_else(|| Error::request("product_id is required"))?;
        let side = self.side
            .ok_or_else(|| Error::request("side is required (use .buy() or .sell())"))?;
        let base_size = self.base_size
            .ok_or_else(|| Error::request("base_size is required"))?;
        let limit_price = self.limit_price
            .ok_or_else(|| Error::request("limit_price is required"))?;

        let config = OrderConfiguration::limit_gtc(base_size, limit_price, self.post_only);
        let client_order_id = self.client_order_id.unwrap_or_else(uuid_v4);

        let request = CreateOrderRequest::new(client_order_id, product_id, side, config);
        self.client.orders().create(request).await
    }
}

/// Builder for limit GTD (good-til-date) orders.
pub struct LimitOrderGtdBuilder<'a> {
    client: &'a RestClient,
    product_id: Option<String>,
    side: Option<OrderSide>,
    base_size: Option<String>,
    limit_price: Option<String>,
    end_time: Option<String>,
    post_only: bool,
    client_order_id: Option<String>,
}

impl<'a> LimitOrderGtdBuilder<'a> {
    /// Create a new limit order GTD builder.
    pub(crate) fn new(client: &'a RestClient) -> Self {
        Self {
            client,
            product_id: None,
            side: None,
            base_size: None,
            limit_price: None,
            end_time: None,
            post_only: false,
            client_order_id: None,
        }
    }

    /// Set as a buy order.
    pub fn buy(mut self, product_id: impl Into<String>) -> Self {
        self.product_id = Some(product_id.into());
        self.side = Some(OrderSide::Buy);
        self
    }

    /// Set as a sell order.
    pub fn sell(mut self, product_id: impl Into<String>) -> Self {
        self.product_id = Some(product_id.into());
        self.side = Some(OrderSide::Sell);
        self
    }

    /// Set the base size.
    pub fn base_size(mut self, base_size: impl Into<String>) -> Self {
        self.base_size = Some(base_size.into());
        self
    }

    /// Set the limit price.
    pub fn limit_price(mut self, limit_price: impl Into<String>) -> Self {
        self.limit_price = Some(limit_price.into());
        self
    }

    /// Set the end time (ISO 8601 format).
    pub fn end_time(mut self, end_time: impl Into<String>) -> Self {
        self.end_time = Some(end_time.into());
        self
    }

    /// Set post-only mode (only add liquidity).
    pub fn post_only(mut self, post_only: bool) -> Self {
        self.post_only = post_only;
        self
    }

    /// Set a custom client order ID.
    pub fn client_order_id(mut self, client_order_id: impl Into<String>) -> Self {
        self.client_order_id = Some(client_order_id.into());
        self
    }

    /// Build and send the order.
    pub async fn send(self) -> Result<CreateOrderResponse> {
        let product_id = self.product_id
            .ok_or_else(|| Error::request("product_id is required"))?;
        let side = self.side
            .ok_or_else(|| Error::request("side is required (use .buy() or .sell())"))?;
        let base_size = self.base_size
            .ok_or_else(|| Error::request("base_size is required"))?;
        let limit_price = self.limit_price
            .ok_or_else(|| Error::request("limit_price is required"))?;
        let end_time = self.end_time
            .ok_or_else(|| Error::request("end_time is required"))?;

        let config = OrderConfiguration::limit_gtd(base_size, limit_price, end_time, self.post_only);
        let client_order_id = self.client_order_id.unwrap_or_else(uuid_v4);

        let request = CreateOrderRequest::new(client_order_id, product_id, side, config);
        self.client.orders().create(request).await
    }
}

/// Builder for stop-limit GTC orders.
pub struct StopLimitOrderGtcBuilder<'a> {
    client: &'a RestClient,
    product_id: Option<String>,
    side: Option<OrderSide>,
    base_size: Option<String>,
    limit_price: Option<String>,
    stop_price: Option<String>,
    stop_direction: Option<StopDirection>,
    client_order_id: Option<String>,
}

impl<'a> StopLimitOrderGtcBuilder<'a> {
    /// Create a new stop-limit order GTC builder.
    pub(crate) fn new(client: &'a RestClient) -> Self {
        Self {
            client,
            product_id: None,
            side: None,
            base_size: None,
            limit_price: None,
            stop_price: None,
            stop_direction: None,
            client_order_id: None,
        }
    }

    /// Set as a buy order.
    pub fn buy(mut self, product_id: impl Into<String>) -> Self {
        self.product_id = Some(product_id.into());
        self.side = Some(OrderSide::Buy);
        self
    }

    /// Set as a sell order.
    pub fn sell(mut self, product_id: impl Into<String>) -> Self {
        self.product_id = Some(product_id.into());
        self.side = Some(OrderSide::Sell);
        self
    }

    /// Set the base size.
    pub fn base_size(mut self, base_size: impl Into<String>) -> Self {
        self.base_size = Some(base_size.into());
        self
    }

    /// Set the limit price.
    pub fn limit_price(mut self, limit_price: impl Into<String>) -> Self {
        self.limit_price = Some(limit_price.into());
        self
    }

    /// Set the stop price.
    pub fn stop_price(mut self, stop_price: impl Into<String>) -> Self {
        self.stop_price = Some(stop_price.into());
        self
    }

    /// Set the stop direction.
    pub fn stop_direction(mut self, stop_direction: StopDirection) -> Self {
        self.stop_direction = Some(stop_direction);
        self
    }

    /// Set a custom client order ID.
    pub fn client_order_id(mut self, client_order_id: impl Into<String>) -> Self {
        self.client_order_id = Some(client_order_id.into());
        self
    }

    /// Build and send the order.
    pub async fn send(self) -> Result<CreateOrderResponse> {
        let product_id = self.product_id
            .ok_or_else(|| Error::request("product_id is required"))?;
        let side = self.side
            .ok_or_else(|| Error::request("side is required (use .buy() or .sell())"))?;
        let base_size = self.base_size
            .ok_or_else(|| Error::request("base_size is required"))?;
        let limit_price = self.limit_price
            .ok_or_else(|| Error::request("limit_price is required"))?;
        let stop_price = self.stop_price
            .ok_or_else(|| Error::request("stop_price is required"))?;
        let stop_direction = self.stop_direction
            .ok_or_else(|| Error::request("stop_direction is required"))?;

        let config = OrderConfiguration::stop_limit_gtc(base_size, limit_price, stop_price, stop_direction);
        let client_order_id = self.client_order_id.unwrap_or_else(uuid_v4);

        let request = CreateOrderRequest::new(client_order_id, product_id, side, config);
        self.client.orders().create(request).await
    }
}

/// Generate a simple UUID v4 string.
fn uuid_v4() -> String {
    use std::time::{SystemTime, UNIX_EPOCH};

    let now = SystemTime::now()
        .duration_since(UNIX_EPOCH)
        .unwrap_or_default()
        .as_nanos();

    // Simple UUID-like format using timestamp and random bits.
    format!(
        "{:08x}-{:04x}-4{:03x}-{:04x}-{:012x}",
        (now >> 96) as u32,
        (now >> 80) as u16,
        (now >> 68) as u16 & 0x0fff,
        ((now >> 52) as u16 & 0x3fff) | 0x8000,
        now as u64 & 0xffffffffffff
    )
}

// Add builder methods to RestClient.
impl RestClient {
    /// Create a market order builder.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use coinbase_advanced::{RestClient, Credentials};
    /// # async fn example() -> coinbase_advanced::Result<()> {
    /// let client = RestClient::builder()
    ///     .credentials(Credentials::from_env()?)
    ///     .build()?;
    ///
    /// // Buy $100 of BTC
    /// let response = client.market_order()
    ///     .buy("BTC-USD")
    ///     .quote_size("100.00")
    ///     .send()
    ///     .await?;
    ///
    /// // Sell 0.001 BTC
    /// let response = client.market_order()
    ///     .sell("BTC-USD")
    ///     .base_size("0.001")
    ///     .send()
    ///     .await?;
    /// # Ok(())
    /// # }
    /// ```
    pub fn market_order(&self) -> MarketOrderBuilder<'_> {
        MarketOrderBuilder::new(self)
    }

    /// Create a limit order (GTC) builder.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use coinbase_advanced::{RestClient, Credentials};
    /// # async fn example() -> coinbase_advanced::Result<()> {
    /// let client = RestClient::builder()
    ///     .credentials(Credentials::from_env()?)
    ///     .build()?;
    ///
    /// let response = client.limit_order_gtc()
    ///     .buy("BTC-USD")
    ///     .base_size("0.001")
    ///     .limit_price("50000.00")
    ///     .post_only(true)
    ///     .send()
    ///     .await?;
    /// # Ok(())
    /// # }
    /// ```
    pub fn limit_order_gtc(&self) -> LimitOrderGtcBuilder<'_> {
        LimitOrderGtcBuilder::new(self)
    }

    /// Create a limit order (GTD) builder.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use coinbase_advanced::{RestClient, Credentials};
    /// # async fn example() -> coinbase_advanced::Result<()> {
    /// let client = RestClient::builder()
    ///     .credentials(Credentials::from_env()?)
    ///     .build()?;
    ///
    /// let response = client.limit_order_gtd()
    ///     .buy("BTC-USD")
    ///     .base_size("0.001")
    ///     .limit_price("50000.00")
    ///     .end_time("2024-12-31T23:59:59Z")
    ///     .send()
    ///     .await?;
    /// # Ok(())
    /// # }
    /// ```
    pub fn limit_order_gtd(&self) -> LimitOrderGtdBuilder<'_> {
        LimitOrderGtdBuilder::new(self)
    }

    /// Create a stop-limit order (GTC) builder.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use coinbase_advanced::{RestClient, Credentials, models::StopDirection};
    /// # async fn example() -> coinbase_advanced::Result<()> {
    /// let client = RestClient::builder()
    ///     .credentials(Credentials::from_env()?)
    ///     .build()?;
    ///
    /// let response = client.stop_limit_order_gtc()
    ///     .sell("BTC-USD")
    ///     .base_size("0.001")
    ///     .limit_price("49000.00")
    ///     .stop_price("50000.00")
    ///     .stop_direction(StopDirection::StopDirectionStopDown)
    ///     .send()
    ///     .await?;
    /// # Ok(())
    /// # }
    /// ```
    pub fn stop_limit_order_gtc(&self) -> StopLimitOrderGtcBuilder<'_> {
        StopLimitOrderGtcBuilder::new(self)
    }
}