polyoxide-clob 0.12.4

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

use polyoxide_core::HttpClient;
use serde::{Deserialize, Serialize};

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

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

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

    /// List notifications for the current user
    pub fn list(&self) -> Request<Vec<Notification>> {
        Request::get(
            self.http_client.clone(),
            "/notifications",
            self.l2_auth(),
            self.chain_id,
        )
    }

    /// Drop (dismiss) notifications by ID
    pub async fn drop(&self, ids: impl Into<Vec<String>>) -> Result<serde_json::Value, ClobError> {
        #[derive(Serialize)]
        struct Body {
            ids: Vec<String>,
        }

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

/// A notification from the CLOB API.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Notification {
    pub id: String,
    #[serde(rename = "type")]
    pub notification_type: u32,
    pub owner: String,
    #[serde(default)]
    pub payload: serde_json::Value,
    #[serde(default)]
    pub timestamp: Option<String>,
}

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

    #[test]
    fn notification_deserializes() {
        let json = r#"{
            "id": "notif-1",
            "type": 1,
            "owner": "0xabc123",
            "payload": {"order_id": "order-456", "side": "BUY"},
            "timestamp": "2024-01-01T00:00:00Z"
        }"#;
        let notif: Notification = serde_json::from_str(json).unwrap();
        assert_eq!(notif.id, "notif-1");
        assert_eq!(notif.notification_type, 1);
        assert_eq!(notif.owner, "0xabc123");
        assert_eq!(notif.payload["order_id"], "order-456");
        assert_eq!(notif.timestamp.as_deref(), Some("2024-01-01T00:00:00Z"));
    }

    #[test]
    fn notification_null_payload() {
        let json = r#"{
            "id": "notif-2",
            "type": 0,
            "owner": "0xdef456",
            "payload": null
        }"#;
        let notif: Notification = serde_json::from_str(json).unwrap();
        assert_eq!(notif.id, "notif-2");
        assert_eq!(notif.notification_type, 0);
        assert!(notif.payload.is_null());
        assert!(notif.timestamp.is_none());
    }

    #[test]
    fn notification_missing_payload() {
        let json = r#"{
            "id": "notif-3",
            "type": 2,
            "owner": "0x789"
        }"#;
        let notif: Notification = serde_json::from_str(json).unwrap();
        assert_eq!(notif.id, "notif-3");
        assert_eq!(notif.notification_type, 2);
        assert!(notif.payload.is_null());
    }
}