polyoxide-relay 0.12.5

Rust client library for Polymarket Relayer 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
use crate::error::RelayError;
use alloy::primitives::{address, Address};
use polyoxide_core::{current_timestamp, Base64Format, Signer};
use reqwest::header::{HeaderMap, HeaderValue};

/// On-chain contract addresses and RPC configuration for a specific chain.
#[derive(Clone, Debug)]
pub struct ContractConfig {
    pub safe_factory: Address,
    pub safe_multisend: Address,
    pub proxy_factory: Option<Address>,
    pub relay_hub: Option<Address>,
    pub rpc_url: &'static str,
}

/// Returns contract addresses for a supported chain, or `None` for unknown chain IDs.
///
/// Supported chains: Polygon mainnet (137), Amoy testnet (80002).
pub fn get_contract_config(chain_id: u64) -> Option<ContractConfig> {
    match chain_id {
        137 => Some(ContractConfig {
            safe_factory: address!("aacFeEa03eb1561C4e67d661e40682Bd20E3541b"),
            safe_multisend: address!("A238CBeb142c10Ef7Ad8442C6D1f9E89e07e7761"),
            proxy_factory: Some(address!("aB45c5A4B0c941a2F231C04C3f49182e1A254052")),
            relay_hub: Some(address!("D216153c06E857cD7f72665E0aF1d7D82172F494")),
            rpc_url: "https://polygon.drpc.org",
        }),
        80002 => Some(ContractConfig {
            safe_factory: address!("aacFeEa03eb1561C4e67d661e40682Bd20E3541b"),
            safe_multisend: address!("A238CBeb142c10Ef7Ad8442C6D1f9E89e07e7761"),
            proxy_factory: None, // Proxy not supported on Amoy testnet
            relay_hub: None,
            rpc_url: "https://rpc-amoy.polygon.technology",
        }),
        _ => None,
    }
}

/// API credentials for authenticating relay requests.
///
/// The `Debug` implementation redacts all secret fields to prevent accidental
/// leakage in logs.
#[derive(Clone)]
pub struct BuilderConfig {
    pub key: String,
    pub secret: String,
    pub passphrase: Option<String>,
}

impl std::fmt::Debug for BuilderConfig {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("BuilderConfig")
            .field("key", &"[REDACTED]")
            .field("secret", &"[REDACTED]")
            .field(
                "passphrase",
                &self.passphrase.as_ref().map(|_| "[REDACTED]"),
            )
            .finish()
    }
}

impl BuilderConfig {
    /// Create a new builder config with the given API credentials.
    pub fn new(key: String, secret: String, passphrase: Option<String>) -> Self {
        Self {
            key,
            secret,
            passphrase,
        }
    }

    /// Generate HMAC-authenticated headers for Relay v1 requests.
    ///
    /// Uses the raw secret string for HMAC signing with standard base64 output.
    pub fn generate_headers(
        &self,
        method: &str,
        path: &str,
        body: Option<&str>,
    ) -> Result<HeaderMap, String> {
        let mut headers = HeaderMap::new();
        let timestamp = current_timestamp();

        // Create signer from raw string secret (Relay v1 uses raw secrets)
        let signer = Signer::from_raw(&self.secret);
        let message = Signer::create_message(timestamp, method, path, body);
        let signature = signer.sign(&message, Base64Format::Standard)?;

        headers.insert(
            "POLY-API-KEY",
            HeaderValue::from_str(&self.key).map_err(|e| e.to_string())?,
        );
        headers.insert(
            "POLY-TIMESTAMP",
            HeaderValue::from_str(&timestamp.to_string()).map_err(|e| e.to_string())?,
        );
        headers.insert(
            "POLY-SIGNATURE",
            HeaderValue::from_str(&signature).map_err(|e| e.to_string())?,
        );

        if let Some(passphrase) = &self.passphrase {
            headers.insert(
                "POLY-PASSPHRASE",
                HeaderValue::from_str(passphrase).map_err(|e| e.to_string())?,
            );
        }

        Ok(headers)
    }

    /// Generate HMAC-authenticated headers for Relay v2 requests.
    ///
    /// Uses base64-decoded secret for HMAC signing with URL-safe base64 output.
    pub fn generate_relayer_v2_headers(
        &self,
        method: &str,
        path: &str,
        body: Option<&str>,
    ) -> Result<HeaderMap, String> {
        let mut headers = HeaderMap::new();
        let timestamp = current_timestamp();

        // Create signer from base64-encoded secret (Relay v2 uses base64 secrets)
        let signer = Signer::new(&self.secret);
        let message = Signer::create_message(timestamp, method, path, body);
        let signature = signer.sign(&message, Base64Format::UrlSafe)?;

        headers.insert(
            "POLY_BUILDER_API_KEY",
            HeaderValue::from_str(&self.key).map_err(|e| e.to_string())?,
        );
        headers.insert(
            "POLY_BUILDER_TIMESTAMP",
            HeaderValue::from_str(&timestamp.to_string()).map_err(|e| e.to_string())?,
        );
        headers.insert(
            "POLY_BUILDER_SIGNATURE",
            HeaderValue::from_str(&signature).map_err(|e| e.to_string())?,
        );

        if let Some(passphrase) = &self.passphrase {
            headers.insert(
                "POLY_BUILDER_PASSPHRASE",
                HeaderValue::from_str(passphrase).map_err(|e| e.to_string())?,
            );
        }

        Ok(headers)
    }
}

/// Relayer API Key credentials for authenticated relay requests.
///
/// A simpler alternative to [`BuilderConfig`] that uses static headers
/// instead of HMAC-signed requests. See
/// <https://docs.polymarket.com/trading/gasless#using-relayer-api-keys>.
///
/// The `Debug` implementation redacts all secret fields to prevent accidental
/// leakage in logs.
#[derive(Clone)]
pub struct RelayerApiKeyConfig {
    key: String,
    address: String,
}

impl std::fmt::Debug for RelayerApiKeyConfig {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("RelayerApiKeyConfig")
            .field("key", &"[REDACTED]")
            .field("address", &self.address)
            .finish()
    }
}

impl RelayerApiKeyConfig {
    /// Create a new relayer API key config.
    ///
    /// Returns an error if `key` or `address` is empty or whitespace-only.
    pub fn new(key: String, address: String) -> Result<Self, RelayError> {
        if key.trim().is_empty() {
            return Err(RelayError::Api(
                "RelayerApiKeyConfig: key must not be empty or whitespace".to_string(),
            ));
        }
        if address.trim().is_empty() {
            return Err(RelayError::Api(
                "RelayerApiKeyConfig: address must not be empty or whitespace".to_string(),
            ));
        }
        Ok(Self { key, address })
    }

    /// Returns the relayer API key.
    pub fn key(&self) -> &str {
        &self.key
    }

    /// Returns the on-chain address associated with the relayer API key.
    pub fn address(&self) -> &str {
        &self.address
    }

    /// Generate static authentication headers for relayer API key requests.
    pub fn generate_headers(&self) -> Result<HeaderMap, String> {
        let mut headers = HeaderMap::new();
        headers.insert(
            "RELAYER_API_KEY",
            HeaderValue::from_str(&self.key).map_err(|e| e.to_string())?,
        );
        headers.insert(
            "RELAYER_API_KEY_ADDRESS",
            HeaderValue::from_str(&self.address).map_err(|e| e.to_string())?,
        );
        Ok(headers)
    }
}

/// Authentication configuration for relay requests.
///
/// Two authentication schemes are supported:
/// - [`Builder`](AuthConfig::Builder) — HMAC-SHA256 signed headers (builder API credentials)
/// - [`RelayerApiKey`](AuthConfig::RelayerApiKey) — static headers (relayer API key)
#[derive(Clone, Debug)]
pub enum AuthConfig {
    /// HMAC-authenticated builder API credentials.
    Builder(BuilderConfig),
    /// Static relayer API key headers.
    RelayerApiKey(RelayerApiKeyConfig),
}

impl AuthConfig {
    /// Generate authentication headers for Relay v2 requests.
    ///
    /// For [`Builder`](AuthConfig::Builder), this produces HMAC-signed headers.
    /// For [`RelayerApiKey`](AuthConfig::RelayerApiKey), this produces static headers
    /// (the `method`, `path`, and `body` parameters are ignored).
    pub fn generate_relayer_v2_headers(
        &self,
        method: &str,
        path: &str,
        body: Option<&str>,
    ) -> Result<HeaderMap, String> {
        match self {
            AuthConfig::Builder(config) => config.generate_relayer_v2_headers(method, path, body),
            AuthConfig::RelayerApiKey(config) => config.generate_headers(),
        }
    }
}

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

    #[test]
    fn test_builder_config_debug_redacts_secrets() {
        let config = BuilderConfig::new(
            "my-api-key".to_string(),
            "my-secret".to_string(),
            Some("my-passphrase".to_string()),
        );
        let debug_output = format!("{:?}", config);

        assert!(debug_output.contains("[REDACTED]"));
        assert!(
            !debug_output.contains("my-api-key"),
            "Debug leaked API key: {}",
            debug_output
        );
        assert!(
            !debug_output.contains("my-secret"),
            "Debug leaked secret: {}",
            debug_output
        );
        assert!(
            !debug_output.contains("my-passphrase"),
            "Debug leaked passphrase: {}",
            debug_output
        );
    }

    #[test]
    fn test_builder_config_debug_without_passphrase() {
        let config = BuilderConfig::new("key".to_string(), "secret".to_string(), None);
        let debug_output = format!("{:?}", config);

        assert!(debug_output.contains("[REDACTED]"));
        assert!(debug_output.contains("passphrase: None"));
    }

    #[test]
    fn test_relayer_api_key_generates_correct_headers() {
        let config =
            RelayerApiKeyConfig::new("my-relayer-key".to_string(), "0xabc123".to_string()).unwrap();
        let headers = config.generate_headers().unwrap();
        assert_eq!(
            headers.get("RELAYER_API_KEY").unwrap().to_str().unwrap(),
            "my-relayer-key"
        );
        assert_eq!(
            headers
                .get("RELAYER_API_KEY_ADDRESS")
                .unwrap()
                .to_str()
                .unwrap(),
            "0xabc123"
        );
        assert_eq!(headers.len(), 2);
    }

    #[test]
    fn test_relayer_api_key_debug_redacts_secrets() {
        let config =
            RelayerApiKeyConfig::new("my-relayer-key".to_string(), "0xabc123".to_string()).unwrap();
        let debug_output = format!("{:?}", config);
        assert!(debug_output.contains("[REDACTED]"));
        assert!(
            !debug_output.contains("my-relayer-key"),
            "Debug leaked API key: {debug_output}"
        );
    }

    #[test]
    fn test_auth_config_builder_delegates_correctly() {
        let builder = BuilderConfig::new(
            "key".to_string(),
            "c2VjcmV0".to_string(),
            Some("pass".to_string()),
        );
        let auth = AuthConfig::Builder(builder);
        let headers = auth
            .generate_relayer_v2_headers("POST", "/submit", Some("{}"))
            .unwrap();
        assert!(headers.get("POLY_BUILDER_API_KEY").is_some());
        assert!(headers.get("RELAYER_API_KEY").is_none());
    }

    #[test]
    fn test_auth_config_relayer_api_key_delegates_correctly() {
        let relayer = RelayerApiKeyConfig::new("rk".to_string(), "0xaddr".to_string()).unwrap();
        let auth = AuthConfig::RelayerApiKey(relayer);
        let headers = auth
            .generate_relayer_v2_headers("POST", "/submit", Some("{}"))
            .unwrap();
        assert!(headers.get("RELAYER_API_KEY").is_some());
        assert!(headers.get("POLY_BUILDER_API_KEY").is_none());
    }

    #[test]
    fn test_relayer_api_key_new_rejects_empty_key() {
        let result = RelayerApiKeyConfig::new(String::new(), "0xaddr".to_string());
        assert!(result.is_err());
    }

    #[test]
    fn test_relayer_api_key_new_rejects_whitespace_key() {
        let result = RelayerApiKeyConfig::new("   ".to_string(), "0xaddr".to_string());
        assert!(result.is_err());
    }

    #[test]
    fn test_relayer_api_key_new_rejects_empty_address() {
        let result = RelayerApiKeyConfig::new("key".to_string(), String::new());
        assert!(result.is_err());
    }

    #[test]
    fn test_relayer_api_key_new_rejects_whitespace_address() {
        let result = RelayerApiKeyConfig::new("key".to_string(), "\t\n".to_string());
        assert!(result.is_err());
    }

    #[test]
    fn test_relayer_api_key_generate_headers_rejects_invalid_header_value() {
        // A newline in a header value is not legal; HeaderValue::from_str must reject it.
        let config = RelayerApiKeyConfig {
            key: "bad\nkey".to_string(),
            address: "0xaddr".to_string(),
        };
        let result = config.generate_headers();
        assert!(result.is_err());
    }

    #[test]
    fn test_relayer_api_key_headers_parameter_independent() {
        let relayer = RelayerApiKeyConfig::new("rk".to_string(), "0xaddr".to_string()).unwrap();
        let auth = AuthConfig::RelayerApiKey(relayer);

        let h1 = auth
            .generate_relayer_v2_headers("POST", "/submit", Some("{}"))
            .unwrap();
        let h2 = auth
            .generate_relayer_v2_headers("GET", "/other/path", None)
            .unwrap();
        let h3 = auth
            .generate_relayer_v2_headers("PUT", "/yet-another", Some("{\"a\":1}"))
            .unwrap();

        assert_eq!(h1, h2);
        assert_eq!(h2, h3);
    }
}