polymarket-hft 0.0.7

A high-frequency trading system for Polymarket with built-in API clients (Data API, CLOB, CLOB WebSocket, Gamma, RTDS) and CLI
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
//! Activity-related types and API methods.
//!
//! This module provides types and methods for querying user on-chain activity.

use serde::{Deserialize, Deserializer, Serialize};
use tracing::{instrument, trace};
use url::Url;

use super::{
    Client, SortDirection, TradeSide, validate_event_id, validate_limit, validate_market_id,
    validate_user,
};
use crate::error::{PolymarketError, Result};

// ============================================================================
// Types
// ============================================================================

/// Deserialize TradeSide, treating empty strings as None.
fn deserialize_optional_trade_side<'de, D>(
    deserializer: D,
) -> std::result::Result<Option<TradeSide>, D::Error>
where
    D: Deserializer<'de>,
{
    let s: Option<String> = Option::deserialize(deserializer)?;
    match s {
        Some(ref val) if val.is_empty() => Ok(None),
        Some(val) => match val.as_str() {
            "BUY" => Ok(Some(TradeSide::Buy)),
            "SELL" => Ok(Some(TradeSide::Sell)),
            _ => Ok(None),
        },
        None => Ok(None),
    }
}

/// Activity type enum for user activity.
#[derive(Debug, Clone, Copy, Serialize, Deserialize)]
pub enum ActivityType {
    /// Trade activity.
    #[serde(rename = "TRADE")]
    Trade,
    /// Split activity.
    #[serde(rename = "SPLIT")]
    Split,
    /// Merge activity.
    #[serde(rename = "MERGE")]
    Merge,
    /// Redeem activity.
    #[serde(rename = "REDEEM")]
    Redeem,
    /// Reward activity.
    #[serde(rename = "REWARD")]
    Reward,
    /// Conversion activity.
    #[serde(rename = "CONVERSION")]
    Conversion,
}

impl std::fmt::Display for ActivityType {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            ActivityType::Trade => write!(f, "TRADE"),
            ActivityType::Split => write!(f, "SPLIT"),
            ActivityType::Merge => write!(f, "MERGE"),
            ActivityType::Redeem => write!(f, "REDEEM"),
            ActivityType::Reward => write!(f, "REWARD"),
            ActivityType::Conversion => write!(f, "CONVERSION"),
        }
    }
}

impl std::str::FromStr for ActivityType {
    type Err = String;

    fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
        match s.to_uppercase().as_str() {
            "TRADE" => Ok(ActivityType::Trade),
            "SPLIT" => Ok(ActivityType::Split),
            "MERGE" => Ok(ActivityType::Merge),
            "REDEEM" => Ok(ActivityType::Redeem),
            "REWARD" => Ok(ActivityType::Reward),
            "CONVERSION" => Ok(ActivityType::Conversion),
            _ => Err(format!(
                "Invalid activity type: '{}'. Valid options: TRADE, SPLIT, MERGE, REDEEM, REWARD, CONVERSION",
                s
            )),
        }
    }
}

/// Sort by options for activity query.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, Default)]
pub enum ActivitySortBy {
    /// Sort by timestamp (default).
    #[serde(rename = "TIMESTAMP")]
    #[default]
    Timestamp,
    /// Sort by token count.
    #[serde(rename = "TOKENS")]
    Tokens,
    /// Sort by cash amount.
    #[serde(rename = "CASH")]
    Cash,
}

impl std::fmt::Display for ActivitySortBy {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            ActivitySortBy::Timestamp => write!(f, "TIMESTAMP"),
            ActivitySortBy::Tokens => write!(f, "TOKENS"),
            ActivitySortBy::Cash => write!(f, "CASH"),
        }
    }
}

impl std::str::FromStr for ActivitySortBy {
    type Err = String;

    fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
        match s.to_uppercase().as_str() {
            "TIMESTAMP" => Ok(ActivitySortBy::Timestamp),
            "TOKENS" => Ok(ActivitySortBy::Tokens),
            "CASH" => Ok(ActivitySortBy::Cash),
            _ => Err(format!(
                "Invalid sort by: '{}'. Valid options: TIMESTAMP, TOKENS, CASH",
                s
            )),
        }
    }
}

/// A user activity record.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Activity {
    /// Proxy wallet address (0x-prefixed, 40 hex chars).
    #[serde(rename = "proxyWallet")]
    pub proxy_wallet: String,
    /// Unix timestamp.
    pub timestamp: i64,
    /// Condition ID (0x-prefixed, 64 hex string).
    #[serde(rename = "conditionId")]
    pub condition_id: String,
    /// Activity type.
    #[serde(rename = "type")]
    pub activity_type: ActivityType,
    /// Activity size.
    pub size: f64,
    /// USDC size.
    #[serde(rename = "usdcSize")]
    pub usdc_size: f64,
    /// Transaction hash.
    #[serde(rename = "transactionHash")]
    pub transaction_hash: String,
    /// Price.
    pub price: f64,
    /// Asset identifier.
    pub asset: String,
    /// Trade side (BUY or SELL), None for non-trade activities.
    #[serde(default, deserialize_with = "deserialize_optional_trade_side")]
    pub side: Option<TradeSide>,
    /// Outcome index.
    #[serde(rename = "outcomeIndex")]
    pub outcome_index: i32,
    /// Market title.
    pub title: String,
    /// Market slug.
    pub slug: String,
    /// Market icon URL.
    pub icon: String,
    /// Event slug.
    #[serde(rename = "eventSlug")]
    pub event_slug: String,
    /// Activity outcome.
    pub outcome: String,
    /// User name.
    pub name: String,
    /// User pseudonym.
    pub pseudonym: String,
    /// User bio.
    pub bio: String,
    /// Profile image URL.
    #[serde(rename = "profileImage")]
    pub profile_image: String,
    /// Optimized profile image URL.
    #[serde(rename = "profileImageOptimized")]
    pub profile_image_optimized: String,
}

/// Request parameters for [`Client::get_user_activity`].
///
/// # Example
///
/// ```no_run
/// use polymarket_hft::client::polymarket::data::{Client, GetUserActivityRequest, ActivityType, ActivitySortBy, SortDirection};
///
/// #[tokio::main]
/// async fn main() -> Result<(), Box<dyn std::error::Error>> {
///     let client = Client::new();
///     let activity_types = vec![ActivityType::Trade];
///     let activity = client.get_user_activity(GetUserActivityRequest {
///         user: "0x56687bf447db6ffa42ffe2204a05edaa20f55839",
///         limit: Some(50),
///         activity_types: Some(&activity_types),
///         ..Default::default()
///     }).await?;
///     Ok(())
/// }
/// ```
#[derive(Debug, Clone, Default)]
pub struct GetUserActivityRequest<'a> {
    /// User Profile Address (0x-prefixed, 40 hex chars). Required.
    pub user: &'a str,
    /// Limit for results (0-500, default: 100).
    pub limit: Option<i32>,
    /// Offset for pagination (0-10000, default: 0).
    pub offset: Option<i32>,
    /// Market condition IDs to filter by. Mutually exclusive with event_ids.
    pub markets: Option<&'a [&'a str]>,
    /// Event IDs to filter by. Mutually exclusive with markets.
    pub event_ids: Option<&'a [i64]>,
    /// Activity types to filter by.
    pub activity_types: Option<&'a [ActivityType]>,
    /// Start timestamp (>= 0).
    pub start: Option<i64>,
    /// End timestamp (>= 0).
    pub end: Option<i64>,
    /// Sort field (default: TIMESTAMP).
    pub sort_by: Option<ActivitySortBy>,
    /// Sort direction (default: DESC).
    pub sort_direction: Option<SortDirection>,
    /// Trade side filter.
    pub side: Option<TradeSide>,
}

impl GetUserActivityRequest<'_> {
    /// Validates the request parameters.
    pub fn validate(&self) -> Result<()> {
        validate_user(self.user)?;
        validate_limit(self.limit)?;

        if let Some(o) = self.offset
            && !(0..=10000).contains(&o)
        {
            return Err(PolymarketError::bad_request(
                "offset must be between 0 and 10000".to_string(),
            ));
        }

        // markets and event_ids are mutually exclusive
        if self.markets.map(|m| !m.is_empty()).unwrap_or(false)
            && self.event_ids.map(|e| !e.is_empty()).unwrap_or(false)
        {
            return Err(PolymarketError::bad_request(
                "market and eventId are mutually exclusive".to_string(),
            ));
        }

        if let Some(market_ids) = self.markets {
            for market_id in market_ids {
                validate_market_id(market_id)?;
            }
        }

        if let Some(ids) = self.event_ids {
            for id in ids {
                validate_event_id(*id)?;
            }
        }

        if let Some(s) = self.start
            && s < 0
        {
            return Err(PolymarketError::bad_request(
                "start must be >= 0".to_string(),
            ));
        }

        if let Some(e) = self.end
            && e < 0
        {
            return Err(PolymarketError::bad_request("end must be >= 0".to_string()));
        }

        if let (Some(s), Some(e)) = (self.start, self.end)
            && s > e
        {
            return Err(PolymarketError::bad_request(
                "start must be <= end".to_string(),
            ));
        }

        Ok(())
    }

    /// Builds the URL with query parameters for this request.
    pub fn build_url(&self, base_url: &Url) -> Url {
        let mut url = base_url.clone();
        url.set_path("activity");

        // Required: user parameter
        url.query_pairs_mut().append_pair("user", self.user);

        // Optional: limit
        if let Some(l) = self.limit {
            url.query_pairs_mut().append_pair("limit", &l.to_string());
        }

        // Optional: offset
        if let Some(o) = self.offset {
            url.query_pairs_mut().append_pair("offset", &o.to_string());
        }

        // Optional: market filter (comma-separated)
        if let Some(market_ids) = self.markets.filter(|ids| !ids.is_empty()) {
            let market_value = market_ids.join(",");
            url.query_pairs_mut().append_pair("market", &market_value);
        }

        // Optional: eventId filter (comma-separated)
        if let Some(ids) = self.event_ids.filter(|ids| !ids.is_empty()) {
            let event_value = ids
                .iter()
                .map(|id| id.to_string())
                .collect::<Vec<_>>()
                .join(",");
            url.query_pairs_mut().append_pair("eventId", &event_value);
        }

        // Optional: type filter (comma-separated)
        if let Some(types) = self.activity_types.filter(|t| !t.is_empty()) {
            let type_value = types
                .iter()
                .map(|t| t.to_string())
                .collect::<Vec<_>>()
                .join(",");
            url.query_pairs_mut().append_pair("type", &type_value);
        }

        // Optional: start
        if let Some(s) = self.start {
            url.query_pairs_mut().append_pair("start", &s.to_string());
        }

        // Optional: end
        if let Some(e) = self.end {
            url.query_pairs_mut().append_pair("end", &e.to_string());
        }

        // Optional: sortBy
        if let Some(sort) = self.sort_by {
            url.query_pairs_mut()
                .append_pair("sortBy", &sort.to_string());
        }

        // Optional: sortDirection
        if let Some(dir) = self.sort_direction {
            url.query_pairs_mut()
                .append_pair("sortDirection", &dir.to_string());
        }

        // Optional: side
        if let Some(s) = self.side {
            url.query_pairs_mut().append_pair("side", &s.to_string());
        }

        url
    }
}

// ============================================================================
// Client Implementation
// ============================================================================

impl Client {
    /// Gets the on-chain activity for a user.
    ///
    /// # Arguments
    ///
    /// * `request` - Request parameters. See [`GetUserActivityRequest`] for details.
    ///
    /// # Returns
    ///
    /// Returns a vector of `Activity` containing the user's on-chain activity.
    ///
    /// # Example
    ///
    /// ```no_run
    /// use polymarket_hft::client::polymarket::data::{Client, GetUserActivityRequest, ActivityType, ActivitySortBy, SortDirection};
    ///
    /// #[tokio::main]
    /// async fn main() -> Result<(), Box<dyn std::error::Error>> {
    ///     let client = Client::new();
    ///     
    ///     // Get all activity for a user
    ///     let activity = client.get_user_activity(GetUserActivityRequest {
    ///         user: "0x56687bf447db6ffa42ffe2204a05edaa20f55839",
    ///         ..Default::default()
    ///     }).await?;
    ///     
    ///     for act in &activity {
    ///         println!("Activity: {:?} - Size: {} - Price: {}", act.activity_type, act.size, act.price);
    ///     }
    ///     
    ///     // Get activity with filters
    ///     let activity_types = vec![ActivityType::Trade];
    ///     let activity = client.get_user_activity(GetUserActivityRequest {
    ///         user: "0x56687bf447db6ffa42ffe2204a05edaa20f55839",
    ///         limit: Some(50),
    ///         activity_types: Some(&activity_types),
    ///         sort_by: Some(ActivitySortBy::Timestamp),
    ///         sort_direction: Some(SortDirection::Desc),
    ///         ..Default::default()
    ///     }).await?;
    ///     
    ///     Ok(())
    /// }
    /// ```
    #[instrument(skip(self, request), fields(user = %request.user), level = "trace")]
    pub async fn get_user_activity(
        &self,
        request: GetUserActivityRequest<'_>,
    ) -> Result<Vec<Activity>> {
        request.validate()?;
        let url = request.build_url(&self.base_url);
        trace!(url = %url, method = "GET", "sending HTTP request");
        let response = self.http_client.get(url).send().await?;
        let response = self.check_response(response).await?;
        let activity: Vec<Activity> = response.json().await?;
        trace!(count = activity.len(), "received activity records");
        Ok(activity)
    }
}

// ============================================================================
// Tests
// ============================================================================

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

    const VALID_USER: &str = "0x0123456789012345678901234567890123456789";
    const VALID_MARKET: &str = "0xdd22472e552920b8438158ea7238bfadfa4f736aa4cee91a6b86c39ead110917";

    #[test]
    fn validate_rejects_start_greater_than_end() {
        let req = GetUserActivityRequest {
            user: "0x0123456789012345678901234567890123456789",
            start: Some(11),
            end: Some(10),
            ..Default::default()
        };

        let err = req.validate().unwrap_err();
        assert!(
            err.to_string().contains("start must be <="),
            "unexpected error: {err}"
        );
    }

    #[test]
    fn validate_rejects_offset_over_limit() {
        let req = GetUserActivityRequest {
            user: VALID_USER,
            offset: Some(10001),
            ..Default::default()
        };

        let err = req.validate().unwrap_err();
        assert!(
            err.to_string()
                .contains("offset must be between 0 and 10000"),
            "unexpected error: {err}"
        );
    }

    #[test]
    fn validate_rejects_market_and_event_together() {
        let markets = &[VALID_MARKET];
        let event_ids = &[1_i64];
        let req = GetUserActivityRequest {
            user: VALID_USER,
            markets: Some(markets),
            event_ids: Some(event_ids),
            ..Default::default()
        };

        let err = req.validate().unwrap_err();
        assert!(
            err.to_string().contains("mutually exclusive"),
            "unexpected error: {err}"
        );
    }

    #[test]
    fn validate_rejects_negative_start() {
        let req = GetUserActivityRequest {
            user: VALID_USER,
            start: Some(-5),
            ..Default::default()
        };

        let err = req.validate().unwrap_err();
        assert!(err.to_string().contains("start must be >="));
    }

    #[test]
    fn build_url_serializes_filters() {
        let base = Url::parse("https://example.com").unwrap();
        let markets = &[VALID_MARKET];
        let activity_types = &[ActivityType::Trade];
        let url = GetUserActivityRequest {
            user: VALID_USER,
            limit: Some(50),
            offset: Some(5),
            markets: Some(markets),
            activity_types: Some(activity_types),
            start: Some(100),
            end: Some(200),
            sort_by: Some(ActivitySortBy::Cash),
            sort_direction: Some(SortDirection::Asc),
            side: Some(TradeSide::Sell),
            ..Default::default()
        }
        .build_url(&base);

        let query = url.query().unwrap_or_default();
        for expected in [
            &format!("user={VALID_USER}"),
            "limit=50",
            "offset=5",
            &format!("market={VALID_MARKET}"),
            "type=TRADE",
            "start=100",
            "end=200",
            "sortBy=CASH",
            "sortDirection=ASC",
            "side=SELL",
        ] {
            assert!(
                query.contains(expected),
                "missing '{expected}' in query: {query}"
            );
        }
    }

    #[test]
    fn test_activity_type_display() {
        assert_eq!(ActivityType::Trade.to_string(), "TRADE");
        assert_eq!(ActivityType::Split.to_string(), "SPLIT");
        assert_eq!(ActivityType::Merge.to_string(), "MERGE");
        assert_eq!(ActivityType::Redeem.to_string(), "REDEEM");
        assert_eq!(ActivityType::Reward.to_string(), "REWARD");
        assert_eq!(ActivityType::Conversion.to_string(), "CONVERSION");
    }

    #[test]
    fn test_activity_type_from_str() {
        assert!(matches!(
            "TRADE".parse::<ActivityType>(),
            Ok(ActivityType::Trade)
        ));
        assert!(matches!(
            "SPLIT".parse::<ActivityType>(),
            Ok(ActivityType::Split)
        ));
        assert!(matches!(
            "MERGE".parse::<ActivityType>(),
            Ok(ActivityType::Merge)
        ));
        assert!(matches!(
            "REDEEM".parse::<ActivityType>(),
            Ok(ActivityType::Redeem)
        ));
        assert!(matches!(
            "REWARD".parse::<ActivityType>(),
            Ok(ActivityType::Reward)
        ));
        assert!(matches!(
            "CONVERSION".parse::<ActivityType>(),
            Ok(ActivityType::Conversion)
        ));
        // Case insensitive
        assert!(matches!(
            "trade".parse::<ActivityType>(),
            Ok(ActivityType::Trade)
        ));
        // Invalid
        assert!("invalid".parse::<ActivityType>().is_err());
    }

    #[test]
    fn test_activity_sort_by_display() {
        assert_eq!(ActivitySortBy::Timestamp.to_string(), "TIMESTAMP");
        assert_eq!(ActivitySortBy::Tokens.to_string(), "TOKENS");
        assert_eq!(ActivitySortBy::Cash.to_string(), "CASH");
    }

    #[test]
    fn test_activity_sort_by_from_str() {
        assert!(matches!(
            "TIMESTAMP".parse::<ActivitySortBy>(),
            Ok(ActivitySortBy::Timestamp)
        ));
        assert!(matches!(
            "TOKENS".parse::<ActivitySortBy>(),
            Ok(ActivitySortBy::Tokens)
        ));
        assert!(matches!(
            "CASH".parse::<ActivitySortBy>(),
            Ok(ActivitySortBy::Cash)
        ));
        // Case insensitive
        assert!(matches!(
            "timestamp".parse::<ActivitySortBy>(),
            Ok(ActivitySortBy::Timestamp)
        ));
        // Invalid
        assert!("invalid".parse::<ActivitySortBy>().is_err());
    }
}