polyoxide-clob 0.12.5

Rust client library for Polymarket CLOB (order book) 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
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
use polyoxide_core::{HttpClient, QueryBuilder};
use serde::{Deserialize, Serialize};

use crate::{
    account::{Credentials, Signer, Wallet},
    error::ClobError,
    request::{AuthMode, Request},
    types::SignedOrder,
};

/// RFQ (Request for Quote) namespace for OTC-style trading
#[derive(Clone)]
pub struct Rfq {
    pub(crate) http_client: HttpClient,
    pub(crate) wallet: Wallet,
    pub(crate) credentials: Credentials,
    pub(crate) signer: Signer,
    pub(crate) chain_id: u64,
}

impl Rfq {
    fn l2_auth(&self) -> AuthMode {
        AuthMode::L2 {
            address: self.wallet.address(),
            credentials: self.credentials.clone(),
            signer: self.signer.clone(),
        }
    }

    // ── Create / Cancel ──────────────────────────────────────────

    /// Create a new RFQ request
    pub async fn create_request(
        &self,
        params: &CreateRfqRequestParams,
    ) -> Result<RfqRequestResponse, ClobError> {
        Request::<RfqRequestResponse>::post(
            self.http_client.clone(),
            "/rfq/request".to_string(),
            self.l2_auth(),
            self.chain_id,
        )
        .body(params)?
        .send()
        .await
    }

    /// Cancel an RFQ request
    pub async fn cancel_request(
        &self,
        request_id: impl Into<String>,
    ) -> Result<serde_json::Value, ClobError> {
        #[derive(Serialize)]
        #[serde(rename_all = "camelCase")]
        struct Body {
            request_id: String,
        }

        Request::<serde_json::Value>::delete(
            self.http_client.clone(),
            "/rfq/request",
            self.l2_auth(),
            self.chain_id,
        )
        .body(&Body {
            request_id: request_id.into(),
        })?
        .send()
        .await
    }

    /// Create a new RFQ quote
    pub async fn create_quote(
        &self,
        params: &CreateRfqQuoteParams,
    ) -> Result<RfqQuoteResponse, ClobError> {
        Request::<RfqQuoteResponse>::post(
            self.http_client.clone(),
            "/rfq/quote".to_string(),
            self.l2_auth(),
            self.chain_id,
        )
        .body(params)?
        .send()
        .await
    }

    /// Cancel an RFQ quote
    pub async fn cancel_quote(
        &self,
        quote_id: impl Into<String>,
    ) -> Result<serde_json::Value, ClobError> {
        #[derive(Serialize)]
        #[serde(rename_all = "camelCase")]
        struct Body {
            quote_id: String,
        }

        Request::<serde_json::Value>::delete(
            self.http_client.clone(),
            "/rfq/quote",
            self.l2_auth(),
            self.chain_id,
        )
        .body(&Body {
            quote_id: quote_id.into(),
        })?
        .send()
        .await
    }

    // ── Accept / Approve ─────────────────────────────────────────

    /// Accept an RFQ request by submitting a signed order
    pub async fn accept_request(
        &self,
        request_id: impl Into<String>,
        quote_id: impl Into<String>,
        signed_order: &SignedOrder,
    ) -> Result<serde_json::Value, ClobError> {
        let payload = serde_json::json!({
            "requestId": request_id.into(),
            "quoteId": quote_id.into(),
            "owner": self.credentials.key,
            "order": signed_order,
        });

        Request::<serde_json::Value>::post(
            self.http_client.clone(),
            "/rfq/request/accept".to_string(),
            self.l2_auth(),
            self.chain_id,
        )
        .body(&payload)?
        .send()
        .await
    }

    /// Approve an RFQ quote by submitting a signed order
    pub async fn approve_quote(
        &self,
        request_id: impl Into<String>,
        quote_id: impl Into<String>,
        signed_order: &SignedOrder,
    ) -> Result<serde_json::Value, ClobError> {
        let payload = serde_json::json!({
            "requestId": request_id.into(),
            "quoteId": quote_id.into(),
            "owner": self.credentials.key,
            "order": signed_order,
        });

        Request::<serde_json::Value>::post(
            self.http_client.clone(),
            "/rfq/quote/approve".to_string(),
            self.l2_auth(),
            self.chain_id,
        )
        .body(&payload)?
        .send()
        .await
    }

    // ── Queries ──────────────────────────────────────────────────

    /// List RFQ requests with optional filtering
    pub fn list_requests(&self) -> ListRfqRequests {
        let request = Request::get(
            self.http_client.clone(),
            "/rfq/data/requests",
            self.l2_auth(),
            self.chain_id,
        );
        ListRfqRequests { request }
    }

    /// List quotes as the requester
    pub fn requester_quotes(&self) -> ListRfqQuotes {
        let request = Request::get(
            self.http_client.clone(),
            "/rfq/data/requester/quotes",
            self.l2_auth(),
            self.chain_id,
        );
        ListRfqQuotes { request }
    }

    /// List quotes as the quoter
    pub fn quoter_quotes(&self) -> ListRfqQuotes {
        let request = Request::get(
            self.http_client.clone(),
            "/rfq/data/quoter/quotes",
            self.l2_auth(),
            self.chain_id,
        );
        ListRfqQuotes { request }
    }

    /// Get the best quote for an RFQ request
    pub fn best_quote(&self, request_id: impl Into<String>) -> Request<RfqQuote> {
        Request::get(
            self.http_client.clone(),
            "/rfq/data/best-quote",
            self.l2_auth(),
            self.chain_id,
        )
        .query("requestId", request_id.into())
    }

    /// Get RFQ system configuration (no auth required)
    pub fn config(&self) -> Request<RfqConfig> {
        Request::get(
            self.http_client.clone(),
            "/rfq/config",
            AuthMode::None,
            self.chain_id,
        )
    }
}

// ── Query builders ───────────────────────────────────────────────

/// Request builder for listing RFQ requests
pub struct ListRfqRequests {
    request: Request<RfqPaginatedResponse<RfqRequest>>,
}

impl ListRfqRequests {
    /// Filter by request IDs
    pub fn request_ids(mut self, ids: impl Into<Vec<String>>) -> Self {
        self.request = self.request.query_many("request_ids", ids.into());
        self
    }

    /// Filter by state ("active" or "inactive")
    pub fn state(mut self, state: impl Into<String>) -> Self {
        self.request = self.request.query("state", state.into());
        self
    }

    /// Filter by markets (condition IDs)
    pub fn markets(mut self, markets: impl Into<Vec<String>>) -> Self {
        self.request = self.request.query_many("markets", markets.into());
        self
    }

    /// Minimum size filter
    pub fn size_min(mut self, min: f64) -> Self {
        self.request = self.request.query("size_min", min);
        self
    }

    /// Maximum size filter
    pub fn size_max(mut self, max: f64) -> Self {
        self.request = self.request.query("size_max", max);
        self
    }

    /// Minimum USDC size filter
    pub fn size_usdc_min(mut self, min: f64) -> Self {
        self.request = self.request.query("size_usdc_min", min);
        self
    }

    /// Maximum USDC size filter
    pub fn size_usdc_max(mut self, max: f64) -> Self {
        self.request = self.request.query("size_usdc_max", max);
        self
    }

    /// Minimum price filter
    pub fn price_min(mut self, min: f64) -> Self {
        self.request = self.request.query("price_min", min);
        self
    }

    /// Maximum price filter
    pub fn price_max(mut self, max: f64) -> Self {
        self.request = self.request.query("price_max", max);
        self
    }

    /// Sort by field ("price", "expiry", "size", "created")
    pub fn sort_by(mut self, field: impl Into<String>) -> Self {
        self.request = self.request.query("sort_by", field.into());
        self
    }

    /// Sort direction ("asc" or "desc")
    pub fn sort_dir(mut self, dir: impl Into<String>) -> Self {
        self.request = self.request.query("sort_dir", dir.into());
        self
    }

    /// Maximum number of results
    pub fn limit(mut self, limit: u32) -> Self {
        self.request = self.request.query("limit", limit);
        self
    }

    /// Pagination offset cursor
    pub fn offset(mut self, offset: impl Into<String>) -> Self {
        self.request = self.request.query("offset", offset.into());
        self
    }

    /// Execute the request
    pub async fn send(self) -> Result<RfqPaginatedResponse<RfqRequest>, ClobError> {
        self.request.send().await
    }
}

/// Request builder for listing RFQ quotes
pub struct ListRfqQuotes {
    request: Request<RfqPaginatedResponse<RfqQuote>>,
}

impl ListRfqQuotes {
    /// Filter by quote IDs
    pub fn quote_ids(mut self, ids: impl Into<Vec<String>>) -> Self {
        self.request = self.request.query_many("quote_ids", ids.into());
        self
    }

    /// Filter by request IDs
    pub fn request_ids(mut self, ids: impl Into<Vec<String>>) -> Self {
        self.request = self.request.query_many("request_ids", ids.into());
        self
    }

    /// Filter by state ("active" or "inactive")
    pub fn state(mut self, state: impl Into<String>) -> Self {
        self.request = self.request.query("state", state.into());
        self
    }

    /// Filter by markets (condition IDs)
    pub fn markets(mut self, markets: impl Into<Vec<String>>) -> Self {
        self.request = self.request.query_many("markets", markets.into());
        self
    }

    /// Minimum size filter
    pub fn size_min(mut self, min: f64) -> Self {
        self.request = self.request.query("size_min", min);
        self
    }

    /// Maximum size filter
    pub fn size_max(mut self, max: f64) -> Self {
        self.request = self.request.query("size_max", max);
        self
    }

    /// Minimum USDC size filter
    pub fn size_usdc_min(mut self, min: f64) -> Self {
        self.request = self.request.query("size_usdc_min", min);
        self
    }

    /// Maximum USDC size filter
    pub fn size_usdc_max(mut self, max: f64) -> Self {
        self.request = self.request.query("size_usdc_max", max);
        self
    }

    /// Minimum price filter
    pub fn price_min(mut self, min: f64) -> Self {
        self.request = self.request.query("price_min", min);
        self
    }

    /// Maximum price filter
    pub fn price_max(mut self, max: f64) -> Self {
        self.request = self.request.query("price_max", max);
        self
    }

    /// Sort by field ("price", "expiry", "created")
    pub fn sort_by(mut self, field: impl Into<String>) -> Self {
        self.request = self.request.query("sort_by", field.into());
        self
    }

    /// Sort direction ("asc" or "desc")
    pub fn sort_dir(mut self, dir: impl Into<String>) -> Self {
        self.request = self.request.query("sort_dir", dir.into());
        self
    }

    /// Maximum number of results
    pub fn limit(mut self, limit: u32) -> Self {
        self.request = self.request.query("limit", limit);
        self
    }

    /// Pagination offset cursor
    pub fn offset(mut self, offset: impl Into<String>) -> Self {
        self.request = self.request.query("offset", offset.into());
        self
    }

    /// Execute the request
    pub async fn send(self) -> Result<RfqPaginatedResponse<RfqQuote>, ClobError> {
        self.request.send().await
    }
}

// ── Request types ────────────────────────────────────────────────

/// Parameters for creating an RFQ request
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct CreateRfqRequestParams {
    pub asset_in: String,
    pub asset_out: String,
    pub amount_in: String,
    pub amount_out: String,
    pub user_type: u32,
}

/// Parameters for creating an RFQ quote
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct CreateRfqQuoteParams {
    pub request_id: String,
    pub asset_in: String,
    pub asset_out: String,
    pub amount_in: String,
    pub amount_out: String,
}

// ── Response types ───────────────────────────────────────────────

/// Response from creating an RFQ request
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RfqRequestResponse {
    pub request_id: Option<String>,
    pub error: Option<String>,
}

/// Response from creating an RFQ quote
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RfqQuoteResponse {
    pub quote_id: Option<String>,
    pub error: Option<String>,
}

/// Paginated response wrapper for RFQ data endpoints
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RfqPaginatedResponse<T> {
    pub data: Vec<T>,
    pub next_cursor: Option<String>,
    pub limit: Option<u32>,
    pub count: Option<u32>,
    pub total_count: Option<u32>,
}

/// An RFQ request
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RfqRequest {
    pub request_id: String,
    pub user_address: String,
    #[serde(default)]
    pub proxy_address: Option<String>,
    #[serde(default)]
    pub token: Option<String>,
    #[serde(default)]
    pub complement: Option<String>,
    #[serde(default)]
    pub condition: Option<String>,
    #[serde(default)]
    pub side: Option<String>,
    #[serde(default)]
    pub size_in: Option<String>,
    #[serde(default)]
    pub size_out: Option<String>,
    #[serde(default)]
    pub price: Option<f64>,
    #[serde(default)]
    pub accepted_quote_id: Option<String>,
    #[serde(default)]
    pub state: Option<String>,
    #[serde(default)]
    pub expiry: Option<String>,
    #[serde(default)]
    pub created_at: Option<String>,
    #[serde(default)]
    pub updated_at: Option<String>,
}

/// An RFQ quote
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RfqQuote {
    pub quote_id: String,
    pub request_id: String,
    pub user_address: String,
    #[serde(default)]
    pub proxy_address: Option<String>,
    #[serde(default)]
    pub complement: Option<String>,
    #[serde(default)]
    pub condition: Option<String>,
    #[serde(default)]
    pub token: Option<String>,
    #[serde(default)]
    pub side: Option<String>,
    #[serde(default)]
    pub size_in: Option<String>,
    #[serde(default)]
    pub size_out: Option<String>,
    #[serde(default)]
    pub price: Option<f64>,
    #[serde(default)]
    pub state: Option<String>,
    #[serde(default)]
    pub expiry: Option<String>,
    #[serde(default)]
    pub created_at: Option<String>,
    #[serde(default)]
    pub updated_at: Option<String>,
}

/// RFQ system configuration
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RfqConfig {
    #[serde(flatten)]
    pub data: serde_json::Value,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn create_rfq_request_params_serializes() {
        let params = CreateRfqRequestParams {
            asset_in: "0xtoken1".into(),
            asset_out: "0".into(),
            amount_in: "100".into(),
            amount_out: "50".into(),
            user_type: 0,
        };
        let json = serde_json::to_value(&params).unwrap();
        assert_eq!(json["assetIn"], "0xtoken1");
        assert_eq!(json["assetOut"], "0");
        assert_eq!(json["amountIn"], "100");
        assert_eq!(json["amountOut"], "50");
        assert_eq!(json["userType"], 0);
    }

    #[test]
    fn create_rfq_quote_params_serializes() {
        let params = CreateRfqQuoteParams {
            request_id: "req-123".into(),
            asset_in: "0xtoken1".into(),
            asset_out: "0".into(),
            amount_in: "100".into(),
            amount_out: "50".into(),
        };
        let json = serde_json::to_value(&params).unwrap();
        assert_eq!(json["requestId"], "req-123");
        assert_eq!(json["assetIn"], "0xtoken1");
    }

    #[test]
    fn rfq_request_response_deserializes() {
        let json = r#"{"request_id": "req-abc", "error": null}"#;
        let resp: RfqRequestResponse = serde_json::from_str(json).unwrap();
        assert_eq!(resp.request_id.as_deref(), Some("req-abc"));
        assert!(resp.error.is_none());
    }

    #[test]
    fn rfq_request_response_with_error() {
        let json = r#"{"request_id": null, "error": "invalid params"}"#;
        let resp: RfqRequestResponse = serde_json::from_str(json).unwrap();
        assert!(resp.request_id.is_none());
        assert_eq!(resp.error.as_deref(), Some("invalid params"));
    }

    #[test]
    fn rfq_quote_response_deserializes() {
        let json = r#"{"quote_id": "quote-xyz", "error": null}"#;
        let resp: RfqQuoteResponse = serde_json::from_str(json).unwrap();
        assert_eq!(resp.quote_id.as_deref(), Some("quote-xyz"));
    }

    #[test]
    fn rfq_request_deserializes() {
        let json = r#"{
            "request_id": "req-1",
            "user_address": "0xuser",
            "token": "0xtoken",
            "side": "BUY",
            "size_in": "100",
            "size_out": "50",
            "price": 0.5,
            "state": "active",
            "created_at": "2024-01-01T00:00:00Z"
        }"#;
        let req: RfqRequest = serde_json::from_str(json).unwrap();
        assert_eq!(req.request_id, "req-1");
        assert_eq!(req.user_address, "0xuser");
        assert_eq!(req.side.as_deref(), Some("BUY"));
        assert_eq!(req.price, Some(0.5));
        assert_eq!(req.state.as_deref(), Some("active"));
    }

    #[test]
    fn rfq_request_minimal_deserializes() {
        let json = r#"{"request_id": "req-1", "user_address": "0xuser"}"#;
        let req: RfqRequest = serde_json::from_str(json).unwrap();
        assert_eq!(req.request_id, "req-1");
        assert!(req.token.is_none());
        assert!(req.side.is_none());
        assert!(req.price.is_none());
    }

    #[test]
    fn rfq_quote_deserializes() {
        let json = r#"{
            "quote_id": "q-1",
            "request_id": "req-1",
            "user_address": "0xquoter",
            "token": "0xtoken",
            "side": "SELL",
            "price": 0.52,
            "state": "active"
        }"#;
        let quote: RfqQuote = serde_json::from_str(json).unwrap();
        assert_eq!(quote.quote_id, "q-1");
        assert_eq!(quote.request_id, "req-1");
        assert_eq!(quote.price, Some(0.52));
    }

    #[test]
    fn rfq_paginated_response_deserializes() {
        let json = r#"{
            "data": [
                {"request_id": "req-1", "user_address": "0xuser1"},
                {"request_id": "req-2", "user_address": "0xuser2"}
            ],
            "next_cursor": "cursor-abc",
            "limit": 10,
            "count": 2,
            "total_count": 50
        }"#;
        let resp: RfqPaginatedResponse<RfqRequest> = serde_json::from_str(json).unwrap();
        assert_eq!(resp.data.len(), 2);
        assert_eq!(resp.data[0].request_id, "req-1");
        assert_eq!(resp.next_cursor.as_deref(), Some("cursor-abc"));
        assert_eq!(resp.count, Some(2));
        assert_eq!(resp.total_count, Some(50));
    }

    #[test]
    fn rfq_paginated_response_empty() {
        let json = r#"{"data": []}"#;
        let resp: RfqPaginatedResponse<RfqQuote> = serde_json::from_str(json).unwrap();
        assert!(resp.data.is_empty());
        assert!(resp.next_cursor.is_none());
    }

    #[test]
    fn rfq_config_deserializes() {
        let json = r#"{"min_size": 10, "max_expiry": 3600}"#;
        let config: RfqConfig = serde_json::from_str(json).unwrap();
        assert_eq!(config.data["min_size"], 10);
    }
}