polyoxide-clob 0.19.0

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
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
use polyoxide_core::{HttpClient, QueryBuilder};
use serde::{Deserialize, Serialize};

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

/// Rewards namespace for liquidity reward operations
#[derive(Clone)]
pub struct Rewards {
    pub(crate) http_client: HttpClient,
    pub(crate) wallet: Wallet,
    pub(crate) credentials: Credentials,
    pub(crate) signer: Signer,
    pub(crate) chain_id: u64,
    pub(crate) signature_type: SignatureType,
}

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

    /// Get user earnings for a specific day (`GET /rewards/user`).
    ///
    /// `date` must be in `YYYY-MM-DD` format (required by the API). The
    /// `signature_type` query parameter is taken from the client configuration.
    pub fn earnings(&self, date: impl Into<String>) -> UserEarningsRequest {
        UserEarningsRequest {
            request: Request::get(
                self.http_client.clone(),
                "/rewards/user",
                self.l2_auth(),
                self.chain_id,
            )
            .query("date", date.into())
            .query("signature_type", self.signature_type as u8),
        }
    }

    /// Get user total earnings for a specific day (`GET /rewards/user/total`).
    ///
    /// `date` must be in `YYYY-MM-DD` format (required by the API). The endpoint
    /// returns an array of totals grouped by asset address.
    pub fn total_earnings(&self, date: impl Into<String>) -> UserTotalEarningsRequest {
        UserTotalEarningsRequest {
            request: Request::get(
                self.http_client.clone(),
                "/rewards/user/total",
                self.l2_auth(),
                self.chain_id,
            )
            .query("date", date.into())
            .query("signature_type", self.signature_type as u8),
        }
    }

    /// Get user reward percentages (`GET /rewards/user/percentages`).
    pub fn percentages(&self) -> UserPercentagesRequest {
        UserPercentagesRequest {
            request: Request::get(
                self.http_client.clone(),
                "/rewards/user/percentages",
                self.l2_auth(),
                self.chain_id,
            )
            .query("signature_type", self.signature_type as u8),
        }
    }

    /// Get user earnings broken down by market (`GET /rewards/user/markets`).
    ///
    /// Returns a paginated envelope; the per-market earnings are in `data`.
    /// Pages hold 100 items by default (max 500); feed `next_cursor` back via
    /// [`ListUserRewardMarkets::next_cursor`] until it reads `"LTE="`.
    pub fn market_earnings(&self) -> ListUserRewardMarkets {
        ListUserRewardMarkets {
            request: Request::get(
                self.http_client.clone(),
                "/rewards/user/markets",
                self.l2_auth(),
                self.chain_id,
            )
            .query("signature_type", self.signature_type as u8),
        }
    }

    /// The unauthenticated subset of the rewards API.
    fn public(&self) -> PublicRewards {
        PublicRewards {
            http_client: self.http_client.clone(),
            chain_id: self.chain_id,
        }
    }

    /// Get currently active reward markets (`GET /rewards/markets/current`).
    ///
    /// Returns a paginated envelope (`data`, `next_cursor`, `limit`, `count`);
    /// the reward markets are in the `data` field. Also available without an
    /// account via [`Clob::public_rewards`](crate::Clob::public_rewards).
    pub fn current_markets(&self) -> ListRewardMarkets {
        self.public().current_markets()
    }

    /// Get rewards for a specific market (`GET /rewards/markets/{condition_id}`).
    ///
    /// Also available without an account via
    /// [`Clob::public_rewards`](crate::Clob::public_rewards).
    pub fn market(&self, condition_id: impl Into<String>) -> RewardMarketRequest {
        self.public().market(condition_id)
    }

    /// Search active markets with reward configurations
    /// (`GET /rewards/markets/multi`).
    ///
    /// Also available without an account via
    /// [`Clob::public_rewards`](crate::Clob::public_rewards).
    pub fn multi_markets(&self) -> ListMultiRewardMarkets {
        self.public().multi_markets()
    }

    /// Get current rebated fees for a maker on a given date
    /// (`GET /rebates/current`).
    ///
    /// Also available without an account via
    /// [`Clob::public_rewards`](crate::Clob::public_rewards).
    pub fn current_rebates(
        &self,
        date: impl Into<String>,
        maker_address: impl Into<String>,
    ) -> Request<Vec<RebatedFees>> {
        self.public().current_rebates(date, maker_address)
    }
}

/// The unauthenticated subset of the rewards API.
///
/// `GET /rewards/markets/current`, `/rewards/markets/{condition_id}`,
/// `/rewards/markets/multi`, and `/rebates/current` are documented as public
/// upstream, so they are reachable from a client built without an account (for
/// example via `Clob::public()`). The same methods are mirrored on
/// [`Rewards`] for callers that already hold an authenticated namespace.
#[derive(Clone)]
pub struct PublicRewards {
    pub(crate) http_client: HttpClient,
    pub(crate) chain_id: u64,
}

impl PublicRewards {
    /// Get currently active reward markets (`GET /rewards/markets/current`).
    ///
    /// Returns a paginated envelope (`data`, `next_cursor`, `limit`, `count`);
    /// the reward markets are in the `data` field.
    pub fn current_markets(&self) -> ListRewardMarkets {
        ListRewardMarkets {
            request: Request::get(
                self.http_client.clone(),
                "/rewards/markets/current",
                AuthMode::None,
                self.chain_id,
            ),
        }
    }

    /// Get rewards for a specific market (`GET /rewards/markets/{condition_id}`).
    pub fn market(&self, condition_id: impl Into<String>) -> RewardMarketRequest {
        RewardMarketRequest {
            request: Request::get(
                self.http_client.clone(),
                format!(
                    "/rewards/markets/{}",
                    urlencoding::encode(&condition_id.into())
                ),
                AuthMode::None,
                self.chain_id,
            ),
        }
    }

    /// Search active markets with reward configurations
    /// (`GET /rewards/markets/multi`).
    ///
    /// Supports text search, tag filtering, numeric filters, and sorting.
    /// Pages hold 100 items by default (max 500); a `next_cursor` of `"LTE="`
    /// marks the last page.
    pub fn multi_markets(&self) -> ListMultiRewardMarkets {
        ListMultiRewardMarkets {
            request: Request::get(
                self.http_client.clone(),
                "/rewards/markets/multi",
                AuthMode::None,
                self.chain_id,
            ),
        }
    }

    /// Get current rebated fees for a maker on a given date
    /// (`GET /rebates/current`).
    ///
    /// `date` must be in `YYYY-MM-DD` format. Each entry carries the condition
    /// ID, asset address, and the USDC amount rebated.
    pub fn current_rebates(
        &self,
        date: impl Into<String>,
        maker_address: impl Into<String>,
    ) -> Request<Vec<RebatedFees>> {
        Request::get(
            self.http_client.clone(),
            "/rebates/current",
            AuthMode::None,
            self.chain_id,
        )
        .query("date", date.into())
        .query("maker_address", maker_address.into())
    }
}

/// Sort direction for the rewards market listings.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "UPPERCASE")]
pub enum SortPosition {
    /// Ascending.
    Asc,
    /// Descending.
    Desc,
}

impl SortPosition {
    /// Wire representation.
    pub fn as_str(&self) -> &'static str {
        match self {
            Self::Asc => "ASC",
            Self::Desc => "DESC",
        }
    }
}

impl std::fmt::Display for SortPosition {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.as_str())
    }
}

/// Sort field for [`Rewards::multi_markets`].
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum MultiMarketOrderBy {
    /// Market ID.
    MarketId,
    /// Creation time.
    CreatedAt,
    /// 24-hour volume.
    Volume24hr,
    /// Current spread.
    Spread,
    /// Competitiveness score.
    Competitiveness,
    /// Maximum rewarded spread.
    MaxSpread,
    /// Minimum rewarded size.
    MinSize,
    /// Question text.
    Question,
    /// One-day price change.
    OneDayPriceChange,
    /// Reward rate per day.
    RatePerDay,
    /// Current price.
    Price,
    /// Market end date.
    EndDate,
    /// Market start date.
    StartDate,
    /// Reward program end date.
    RewardEndDate,
}

impl MultiMarketOrderBy {
    /// Wire representation.
    pub fn as_str(&self) -> &'static str {
        match self {
            Self::MarketId => "market_id",
            Self::CreatedAt => "created_at",
            Self::Volume24hr => "volume_24hr",
            Self::Spread => "spread",
            Self::Competitiveness => "competitiveness",
            Self::MaxSpread => "max_spread",
            Self::MinSize => "min_size",
            Self::Question => "question",
            Self::OneDayPriceChange => "one_day_price_change",
            Self::RatePerDay => "rate_per_day",
            Self::Price => "price",
            Self::EndDate => "end_date",
            Self::StartDate => "start_date",
            Self::RewardEndDate => "reward_end_date",
        }
    }
}

impl std::fmt::Display for MultiMarketOrderBy {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.as_str())
    }
}

/// Sort field for [`Rewards::market_earnings`].
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum UserRewardMarketOrderBy {
    /// Maximum rewarded spread.
    MaxSpread,
    /// Minimum rewarded size.
    MinSize,
    /// Market end date.
    EndDate,
    /// Share of the market's reward pool earned.
    EarningPercentage,
    /// Reward rate per day.
    RatePerDay,
    /// Earnings for the day.
    Earnings,
    /// Current spread.
    Spread,
    /// Competitiveness score.
    Competitiveness,
    /// Question text.
    Question,
    /// Current price.
    Price,
    /// Market identifier.
    Market,
    /// 24-hour volume.
    Volume24hr,
}

impl UserRewardMarketOrderBy {
    /// Wire representation.
    pub fn as_str(&self) -> &'static str {
        match self {
            Self::MaxSpread => "max_spread",
            Self::MinSize => "min_size",
            Self::EndDate => "end_date",
            Self::EarningPercentage => "earning_percentage",
            Self::RatePerDay => "rate_per_day",
            Self::Earnings => "earnings",
            Self::Spread => "spread",
            Self::Competitiveness => "competitiveness",
            Self::Question => "question",
            Self::Price => "price",
            Self::Market => "market",
            Self::Volume24hr => "volume_24hr",
        }
    }
}

impl std::fmt::Display for UserRewardMarketOrderBy {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.as_str())
    }
}

/// Request builder for `GET /rewards/user`.
pub struct UserEarningsRequest {
    request: Request<RewardEarnings>,
}

impl UserEarningsRequest {
    /// Query earnings for a maker address other than the authenticated wallet.
    pub fn maker_address(mut self, address: impl Into<String>) -> Self {
        self.request = self.request.query("maker_address", address.into());
        self
    }

    /// Restrict results to sponsored reward markets (default: `false`).
    pub fn sponsored(mut self, sponsored: bool) -> Self {
        self.request = self.request.query("sponsored", sponsored);
        self
    }

    /// Continue from a pagination cursor.
    pub fn next_cursor(mut self, cursor: impl Into<String>) -> Self {
        self.request = self.request.query("next_cursor", cursor.into());
        self
    }

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

/// Request builder for `GET /rewards/user/total`.
pub struct UserTotalEarningsRequest {
    request: Request<Vec<RewardTotalEarnings>>,
}

impl UserTotalEarningsRequest {
    /// Query totals for a maker address other than the authenticated wallet.
    pub fn maker_address(mut self, address: impl Into<String>) -> Self {
        self.request = self.request.query("maker_address", address.into());
        self
    }

    /// Restrict results to sponsored reward markets (default: `false`).
    pub fn sponsored(mut self, sponsored: bool) -> Self {
        self.request = self.request.query("sponsored", sponsored);
        self
    }

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

/// Request builder for `GET /rewards/user/percentages`.
pub struct UserPercentagesRequest {
    request: Request<RewardPercentages>,
}

impl UserPercentagesRequest {
    /// Query percentages for a maker address other than the authenticated wallet.
    pub fn maker_address(mut self, address: impl Into<String>) -> Self {
        self.request = self.request.query("maker_address", address.into());
        self
    }

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

/// Request builder for `GET /rewards/markets/current`.
pub struct ListRewardMarkets {
    request: Request<Paginated<RewardMarket>>,
}

impl ListRewardMarkets {
    /// Restrict results to sponsored reward markets (default: `false`).
    pub fn sponsored(mut self, sponsored: bool) -> Self {
        self.request = self.request.query("sponsored", sponsored);
        self
    }

    /// Continue from a pagination cursor; `"LTE="` marks the last page.
    pub fn next_cursor(mut self, cursor: impl Into<String>) -> Self {
        self.request = self.request.query("next_cursor", cursor.into());
        self
    }

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

/// Request builder for `GET /rewards/markets/{condition_id}`.
pub struct RewardMarketRequest {
    request: Request<RewardMarket>,
}

impl RewardMarketRequest {
    /// Restrict results to sponsored reward markets (default: `false`).
    pub fn sponsored(mut self, sponsored: bool) -> Self {
        self.request = self.request.query("sponsored", sponsored);
        self
    }

    /// Continue from a pagination cursor.
    pub fn next_cursor(mut self, cursor: impl Into<String>) -> Self {
        self.request = self.request.query("next_cursor", cursor.into());
        self
    }

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

/// Request builder for `GET /rewards/markets/multi`.
pub struct ListMultiRewardMarkets {
    request: Request<Paginated<RewardMarket>>,
}

impl ListMultiRewardMarkets {
    /// Free-text search over market questions.
    pub fn query_text(mut self, q: impl Into<String>) -> Self {
        self.request = self.request.query("q", q.into());
        self
    }

    /// Filter by tag slug.
    pub fn tag_slug(mut self, slug: impl Into<String>) -> Self {
        self.request = self.request.query("tag_slug", slug.into());
        self
    }

    /// Filter by event ID.
    pub fn event_id(mut self, event_id: impl Into<String>) -> Self {
        self.request = self.request.query("event_id", event_id.into());
        self
    }

    /// Filter by event title.
    pub fn event_title(mut self, title: impl Into<String>) -> Self {
        self.request = self.request.query("event_title", title.into());
        self
    }

    /// Sort field.
    pub fn order_by(mut self, order_by: MultiMarketOrderBy) -> Self {
        self.request = self.request.query("order_by", order_by.as_str());
        self
    }

    /// Sort direction.
    pub fn position(mut self, position: SortPosition) -> Self {
        self.request = self.request.query("position", position.as_str());
        self
    }

    /// Minimum 24-hour volume.
    pub fn min_volume_24hr(mut self, value: f64) -> Self {
        self.request = self.request.query("min_volume_24hr", value);
        self
    }

    /// Maximum 24-hour volume.
    pub fn max_volume_24hr(mut self, value: f64) -> Self {
        self.request = self.request.query("max_volume_24hr", value);
        self
    }

    /// Minimum spread.
    pub fn min_spread(mut self, value: f64) -> Self {
        self.request = self.request.query("min_spread", value);
        self
    }

    /// Maximum spread.
    pub fn max_spread(mut self, value: f64) -> Self {
        self.request = self.request.query("max_spread", value);
        self
    }

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

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

    /// Page size (default 100, max 500).
    pub fn page_size(mut self, page_size: u32) -> Self {
        self.request = self.request.query("page_size", page_size);
        self
    }

    /// Continue from a pagination cursor; `"LTE="` marks the last page.
    pub fn next_cursor(mut self, cursor: impl Into<String>) -> Self {
        self.request = self.request.query("next_cursor", cursor.into());
        self
    }

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

/// Request builder for `GET /rewards/user/markets`.
pub struct ListUserRewardMarkets {
    request: Request<Paginated<RewardMarketEarning>>,
}

impl ListUserRewardMarkets {
    /// Restrict to a specific day (`YYYY-MM-DD`).
    pub fn date(mut self, date: impl Into<String>) -> Self {
        self.request = self.request.query("date", date.into());
        self
    }

    /// Query a maker address other than the authenticated wallet.
    pub fn maker_address(mut self, address: impl Into<String>) -> Self {
        self.request = self.request.query("maker_address", address.into());
        self
    }

    /// Restrict results to sponsored reward markets (default: `false`).
    pub fn sponsored(mut self, sponsored: bool) -> Self {
        self.request = self.request.query("sponsored", sponsored);
        self
    }

    /// Free-text search over market questions.
    pub fn query_text(mut self, q: impl Into<String>) -> Self {
        self.request = self.request.query("q", q.into());
        self
    }

    /// Filter by tag slug.
    pub fn tag_slug(mut self, slug: impl Into<String>) -> Self {
        self.request = self.request.query("tag_slug", slug.into());
        self
    }

    /// Restrict to the caller's favorited markets (default: `false`).
    pub fn favorite_markets(mut self, value: bool) -> Self {
        self.request = self.request.query("favorite_markets", value);
        self
    }

    /// Restrict to markets with no competing liquidity (default: `false`).
    pub fn no_competition(mut self, value: bool) -> Self {
        self.request = self.request.query("no_competition", value);
        self
    }

    /// Restrict to markets with mergeable positions (default: `false`).
    pub fn only_mergeable(mut self, value: bool) -> Self {
        self.request = self.request.query("only_mergeable", value);
        self
    }

    /// Restrict to markets where the caller has open orders (default: `false`).
    pub fn only_open_orders(mut self, value: bool) -> Self {
        self.request = self.request.query("only_open_orders", value);
        self
    }

    /// Restrict to markets where the caller has open positions (default: `false`).
    pub fn only_open_positions(mut self, value: bool) -> Self {
        self.request = self.request.query("only_open_positions", value);
        self
    }

    /// Sort field.
    pub fn order_by(mut self, order_by: UserRewardMarketOrderBy) -> Self {
        self.request = self.request.query("order_by", order_by.as_str());
        self
    }

    /// Sort direction.
    pub fn position(mut self, position: SortPosition) -> Self {
        self.request = self.request.query("position", position.as_str());
        self
    }

    /// Page size (default 100, max 500).
    pub fn page_size(mut self, page_size: u32) -> Self {
        self.request = self.request.query("page_size", page_size);
        self
    }

    /// Continue from a pagination cursor; `"LTE="` marks the last page.
    pub fn next_cursor(mut self, cursor: impl Into<String>) -> Self {
        self.request = self.request.query("next_cursor", cursor.into());
        self
    }

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

/// Rebated fees for a maker on a specific market and date
/// (`GET /rebates/current`).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RebatedFees {
    /// Date of the rebate (`YYYY-MM-DD`).
    pub date: String,
    /// Condition ID of the market.
    pub condition_id: String,
    /// Asset address (e.g. the USDC contract).
    pub asset_address: String,
    /// Maker's address.
    pub maker_address: String,
    /// Rebated fee amount in USDC, as a decimal string.
    pub rebated_fees_usdc: String,
}

/// User earnings response
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RewardEarnings {
    #[serde(flatten)]
    pub data: serde_json::Value,
}

/// User total accumulated earnings
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RewardTotalEarnings {
    #[serde(flatten)]
    pub data: serde_json::Value,
}

/// User reward percentages
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RewardPercentages {
    #[serde(flatten)]
    pub data: serde_json::Value,
}

/// Per-market earnings breakdown
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RewardMarketEarning {
    #[serde(flatten)]
    pub data: serde_json::Value,
}

/// Reward market information
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RewardMarket {
    #[serde(flatten)]
    pub data: serde_json::Value,
}

/// Pagination envelope used by the rewards list endpoints
/// (`GET /rewards/markets/current` and `GET /rewards/user/markets`).
///
/// These endpoints wrap results in a pagination object rather than returning a
/// bare array, so the items live in [`Self::data`].
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Paginated<T> {
    /// Items for this page.
    #[serde(default = "Vec::new")]
    pub data: Vec<T>,
    /// Cursor for the next page; a value of `"LTE="` indicates the last page.
    #[serde(default)]
    pub next_cursor: Option<String>,
    /// Page size limit reported by the server.
    #[serde(default)]
    pub limit: Option<u32>,
    /// Number of items in this page.
    #[serde(default)]
    pub count: Option<u32>,
}

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

    #[test]
    fn reward_earnings_deserializes() {
        let json = r#"{"amount": "1.5", "day": "2024-01-15"}"#;
        let resp: RewardEarnings = serde_json::from_str(json).unwrap();
        assert_eq!(resp.data["amount"], "1.5");
        assert_eq!(resp.data["day"], "2024-01-15");
    }

    #[test]
    fn reward_total_earnings_deserializes() {
        let json = r#"{"total": "42.0"}"#;
        let resp: RewardTotalEarnings = serde_json::from_str(json).unwrap();
        assert_eq!(resp.data["total"], "42.0");
    }

    #[test]
    fn reward_total_earnings_list_deserializes() {
        // GET /rewards/user/total returns an array of per-asset totals, not a
        // single object. Regression test for that shape (observed live).
        let json = r#"[{"asset_address": "0xabc", "total": "42.0"}]"#;
        let resp: Vec<RewardTotalEarnings> = serde_json::from_str(json).unwrap();
        assert_eq!(resp.len(), 1);
        assert_eq!(resp[0].data["total"], "42.0");
    }

    #[test]
    fn reward_percentages_deserializes() {
        let json = r#"{"maker": "0.5", "taker": "0.3"}"#;
        let resp: RewardPercentages = serde_json::from_str(json).unwrap();
        assert_eq!(resp.data["maker"], "0.5");
    }

    #[test]
    fn reward_market_earning_list_deserializes() {
        let json = r#"[
            {"condition_id": "0xabc", "amount": "10.0"},
            {"condition_id": "0xdef", "amount": "5.0"}
        ]"#;
        let resp: Vec<RewardMarketEarning> = serde_json::from_str(json).unwrap();
        assert_eq!(resp.len(), 2);
        assert_eq!(resp[0].data["condition_id"], "0xabc");
    }

    #[test]
    fn reward_market_deserializes() {
        let json = r#"{"condition_id": "0xabc", "reward_rate": "0.01"}"#;
        let resp: RewardMarket = serde_json::from_str(json).unwrap();
        assert_eq!(resp.data["condition_id"], "0xabc");
    }

    #[test]
    fn reward_market_list_deserializes() {
        let json = r#"[{"condition_id": "0xabc"}, {"condition_id": "0xdef"}]"#;
        let resp: Vec<RewardMarket> = serde_json::from_str(json).unwrap();
        assert_eq!(resp.len(), 2);
    }

    #[test]
    fn current_markets_paginated_response_deserializes() {
        // GET /rewards/markets/current wraps results in a pagination envelope,
        // not a bare array. Regression test for that shape (observed live).
        let json = r#"{
            "limit": 500,
            "count": 1,
            "next_cursor": "LTE=",
            "data": [
                {"condition_id": "0xabc", "rewards_max_spread": 99}
            ]
        }"#;
        let page: Paginated<RewardMarket> =
            serde_json::from_str(json).expect("paginated reward markets should deserialize");
        assert_eq!(page.data.len(), 1);
        assert_eq!(page.count, Some(1));
        assert_eq!(page.next_cursor.as_deref(), Some("LTE="));
        assert_eq!(page.data[0].data["condition_id"], "0xabc");
    }

    #[test]
    fn market_earnings_paginated_response_deserializes() {
        // GET /rewards/user/markets wraps results in the same pagination envelope.
        let json = r#"{
            "limit": 100,
            "count": 1,
            "next_cursor": "LTE=",
            "data": [
                {"condition_id": "0xabc", "earnings": 0.237519}
            ]
        }"#;
        let page: Paginated<RewardMarketEarning> =
            serde_json::from_str(json).expect("paginated market earnings should deserialize");
        assert_eq!(page.data.len(), 1);
        assert_eq!(page.count, Some(1));
        assert_eq!(page.data[0].data["condition_id"], "0xabc");
    }

    #[test]
    fn reward_earnings_empty_object_deserializes() {
        let json = r#"{}"#;
        let resp: RewardEarnings = serde_json::from_str(json).unwrap();
        assert!(resp.data.is_object());
    }
}